org.omg.CORBA

Class TypeCode

public abstract class TypeCode extends Object implements IDLEntity, Serializable

An information about a CORBA data type.

Method Summary
abstract TypeCode	concrete_base_type() For value types that support inheritance this method returns the of the ancestor type code.
abstract TypeCode	content_type() For sequences, arrays, aliases and value boxes, returns the IDL type for the members of the object.
abstract int	default_index() For unions, returs the index of the default member.
abstract TypeCode	discriminator_type() Returs definition of member labels for untions
abstract boolean	equal(TypeCode other) Test two types for equality.
abstract boolean	equivalent(TypeCode other) Following the current 1.4 API specifcation, this should just throw NO_IMPLEMENT.
abstract short	fixed_digits() For the fixed type, returns the number of digits.
abstract short	fixed_scale() Returns the scale for the fixed type.
abstract TypeCode	get_compact_typecode() Returns a version of this instance without the optional memeber and member name fields.
abstract String	id() Returns the RepositoryId globally identifying the type, defined by this TypeCode.
abstract TCKind	kind() Return the kind of this type code object.
abstract int	length() Returns the number of elements in the type.
abstract int	member_count() Returns the number of type memebers.
abstract Any	member_label(int index) Retrieves the label of the union member at the given index.
abstract String	member_name(int index) Retrieves the simple name of the member identified by the given index.
abstract TypeCode	member_type(int index) Retrieves the member type of the member identified by the given index.
abstract short	member_visibility(int index) Returns the visibility scope of the member at the given index.
abstract String	name() Retrieves the simple name identifying this TypeCode object within its enclosing scope.
abstract short	type_modifier() Returns a constant indicating the modifier of the value type.

Method Detail

concrete_base_type

public abstract TypeCode concrete_base_type()

For value types that support inheritance this method returns the of the ancestor type code.

Returns: the ancestor TypeCode.

Throws: BadKind for all typecodes except the value type typecodes.

content_type

public abstract TypeCode content_type()

For sequences, arrays, aliases and value boxes, returns the IDL type for the members of the object.

Returns: a TypeCode of the memebers of this type.

Throws: BadKind for types other than sequences, arrays, aliases and value boxes.

default_index

public abstract int default_index()

For unions, returs the index of the default member.

Returns: the index of the default member, -1 if there is no default member.

Throws: BadKind if this type is not a union.

discriminator_type

public abstract TypeCode discriminator_type()

Returs definition of member labels for untions

Returns: a TypeCode, describing all non-default member labels.

Throws: BadKind if this type is not a union.

equal

public abstract boolean equal(TypeCode other)

Test two types for equality.

Parameters: other the other type to compere with

Returns: true if the types are interchangeable.

equivalent

public abstract boolean equivalent(TypeCode other)

Following the current 1.4 API specifcation, this should just throw NO_IMPLEMENT.

Throws: org.omg.CORBA.NO_IMPLEMENT, always.

fixed_digits

public abstract short fixed_digits()

For the fixed type, returns the number of digits.

Returns: the number of digits for the fixed type

Throws: BadKind if this is not a fixed type.

fixed_scale

public abstract short fixed_scale()

Returns the scale for the fixed type. The returned value can be either positive (the number of digits to the right of the decimal point) or negative (adds zeros to the left of the decimal point).

Returns: the scale.

Throws: BadKind if this is not a fixed type.

get_compact_typecode

public abstract TypeCode get_compact_typecode()

Returns a version of this instance without the optional memeber and member name fields.

Returns: the truncated version.

id

public abstract String id()

Returns the RepositoryId globally identifying the type, defined by this TypeCode.

Returns: tje RepositoryId. In some cases, it may be an empty string.

Throws: BadKind if the type is other than reference, structure, union, enumeration, alias, exception, valuetype, boxed valuetype and also native and abstract interfaces.

kind

public abstract TCKind kind()

Return the kind of this type code object.

Returns: one of the TCKind.t_.. fields.

length

public abstract int length()

Returns the number of elements in the type. For arrays, this method returns the length of the array. For strings and sequences, it returns the bound of the type, zero indicating the unbounded type.

Returns: length or bound

Throws: BadKind for types other than string, sequence and array.

member_count

public abstract int member_count()

Returns the number of type memebers.

Returns: the number of memebers

Throws: BadKind for types other than structure, union, enumeration or exception.

member_label

public abstract Any member_label(int index)

Retrieves the label of the union member at the given index. For the default member, this label is the zero octet.

Parameters: index the index of the union memeber.

Returns: the label

Throws: BadKind if this is not a union type. org.omg.CORBA.TypeCodePackage.Bounds if the index is out of valid bounds.

member_name

public abstract String member_name(int index)

Retrieves the simple name of the member identified by the given index.

Parameters: index the index of the memeber.

Returns: the member name that in some cases can be an empty string.

Throws: BadKind for types other than structure, union or enumeration. org.omg.CORBA.TypeCodePackage.Bounds if the index is out of valid bounds.

member_type

public abstract TypeCode member_type(int index)

Retrieves the member type of the member identified by the given index.

Parameters: index the index of the memeber.

Returns: the member type.

Throws: BadKind for types other than structure, union, enumeration or exception. org.omg.CORBA.TypeCodePackage.Bounds if the index is out of valid bounds.

member_visibility

public abstract short member_visibility(int index)

Returns the visibility scope of the member at the given index. This operation can only be invoked on non-boxed value types.

Parameters: index the index of the member

Returns: either PRIVATE_MEMBER.value or PUBLIC_MEMBER.value

Throws: BadKind if this is not a non boxed value type. org.omg.CORBA.TypeCodePackage.Bounds if the index is out of valid bounds.

name

public abstract String name()

Retrieves the simple name identifying this TypeCode object within its enclosing scope.

Returns: the name, can be an empty string.

Throws: BadKind for typer other than reference, structure, union, enumeration, alias, exception, valuetype, boxed valuetype, native, and abstract interface

type_modifier

public abstract short type_modifier()

Returns a constant indicating the modifier of the value type.

Returns: one of the following constants: VM_NONE.value, VM_ABSTRACT.value, VM_CUSTOM.value, or VM_TRUNCATABLE.value,

Throws: BadKind for all types other than value type.