org.omg.CORBA
Class TypeCode
- IDLEntity, Serializable
An information about a CORBA data type.
- Serialized Form
TypeCode | concrete_base_type() - For value types that support inheritance this method returns the
of the ancestor type code.
|
TypeCode | content_type() - For sequences, arrays, aliases and value boxes, returns the IDL type for
the members of the object.
|
int | default_index() - For unions, returs the index of the default member.
|
TypeCode | discriminator_type() - Returs definition of member labels for untions
|
boolean | equal(TypeCode other) - Test two types for equality.
|
boolean | equivalent(TypeCode other) - Following the current 1.4 API specifcation, this should just throw
NO_IMPLEMENT.
|
short | fixed_digits() - For the fixed type, returns the number of digits.
|
short | fixed_scale() - Returns the scale for the fixed type.
|
TypeCode | get_compact_typecode() - Returns a version of this instance without the optional memeber and
member name fields.
|
String | id() - Returns the RepositoryId globally identifying the type, defined by
this TypeCode.
|
TCKind | kind() - Return the kind of this type code object.
|
int | length() - Returns the number of elements in the type.
|
int | member_count() - Returns the number of type memebers.
|
Any | member_label(int index) - Retrieves the label of the union member at the given index.
|
String | member_name(int index) - Retrieves the simple name of the member identified by the given index.
|
TypeCode | member_type(int index) - Retrieves the member type of the member identified by the given index.
|
short | member_visibility(int index) - Returns the visibility scope of the member at the given index.
|
String | name() - Retrieves the simple name identifying this TypeCode object
within its enclosing scope.
|
short | type_modifier() - Returns a constant indicating the modifier of the value type.
|
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait |
concrete_base_type
public TypeCode concrete_base_type()
throws BadKind
For value types that support inheritance this method returns the
of the ancestor type code.
- the ancestor TypeCode.
BadKind
- for all typecodes except the value type typecodes.
content_type
public TypeCode content_type()
throws BadKind
For sequences, arrays, aliases and value boxes, returns the IDL type for
the members of the object.
- a TypeCode of the memebers of this type.
BadKind
- for types other than
sequences, arrays, aliases and value boxes.
default_index
public int default_index()
throws BadKind
For unions, returs the index of the default member.
- the index of the default member, -1 if there is
no default member.
BadKind
- if this type is not
a union.
discriminator_type
public TypeCode discriminator_type()
throws BadKind
Returs definition of member labels for untions
- a TypeCode, describing all non-default member labels.
BadKind
- if this type is not a
union.
equal
public boolean equal(TypeCode other)
Test two types for equality.
other
- the other type to compere with
- true if the types are interchangeable.
equivalent
public boolean equivalent(TypeCode other)
Following the current 1.4 API specifcation, this should just throw
NO_IMPLEMENT.
fixed_digits
public short fixed_digits()
throws BadKind
For the fixed type, returns the number of digits.
- the number of digits for the fixed type
BadKind
- if this is not a fixed
type.
fixed_scale
public short fixed_scale()
throws BadKind
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).
- the scale.
BadKind
- if this is not a fixed
type.
get_compact_typecode
public TypeCode get_compact_typecode()
Returns a version of this instance without the optional memeber and
member name fields.
- the truncated version.
id
public String id()
throws BadKind
Returns the RepositoryId globally identifying the type, defined by
this TypeCode.
- tje RepositoryId. In some cases, it may be an empty string.
BadKind
- if the type is other than
reference, structure, union, enumeration, alias, exception, valuetype,
boxed valuetype and also native and abstract interfaces.
kind
public TCKind kind()
Return the kind of this type code object.
- one of the
TCKind.t_..
fields.
length
public int length()
throws BadKind
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.
- length or bound
BadKind
- for types other than
string, sequence and array.
member_count
public int member_count()
throws BadKind
Returns the number of type memebers.
- the number of memebers
BadKind
- for types other than
structure, union, enumeration or exception.
member_label
public Any member_label(int index)
throws BadKind,
Bounds
Retrieves the label of the union member at the given index.
For the default member, this label is the zero octet.
index
- the index of the union memeber.
- the label
BadKind
- if this is not a union
type.Bounds
- if the index is out of
valid bounds.
member_name
public String member_name(int index)
throws BadKind,
Bounds
Retrieves the simple name of the member identified by the given index.
index
- the index of the memeber.
- the member name that in some cases can be an empty string.
BadKind
- for types other than
structure, union or enumeration.Bounds
- if the index is out of
valid bounds.
member_type
public TypeCode member_type(int index)
throws BadKind,
Bounds
Retrieves the member type of the member identified by the given index.
index
- the index of the memeber.
- the member type.
BadKind
- for types other than
structure, union, enumeration or exception.Bounds
- if the index is out of
valid bounds.
member_visibility
public short member_visibility(int index)
throws BadKind,
Bounds
Returns the visibility scope of the member at the given index.
This operation can only be invoked on non-boxed value types.
index
- the index of the member
- either PRIVATE_MEMBER.value or PUBLIC_MEMBER.value
BadKind
- if this is not a non boxed
value type.Bounds
- if the index is out of
valid bounds.
name
public String name()
throws BadKind
Retrieves the simple name identifying this TypeCode object
within its enclosing scope.
- the name, can be an empty string.
BadKind
- for typer other than
reference, structure, union, enumeration, alias, exception,
valuetype, boxed valuetype, native, and abstract interface
type_modifier
public short type_modifier()
throws BadKind
Returns a constant indicating the modifier of the value type.
- one of the following constants:
VM_NONE.value, VM_ABSTRACT.value, VM_CUSTOM.value, or
VM_TRUNCATABLE.value,
BadKind
- for all types other than value type.
TypeCode.java --
Copyright (C) 2005 Free Software Foundation, Inc.
This file is part of GNU Classpath.
GNU Classpath is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2, or (at your option)
any later version.
GNU Classpath is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
General Public License for more details.
You should have received a copy of the GNU General Public License
along with GNU Classpath; see the file COPYING. If not, write to the
Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
02110-1301 USA.
Linking this library statically or dynamically with other modules is
making a combined work based on this library. Thus, the terms and
conditions of the GNU General Public License cover the whole
combination.
As a special exception, the copyright holders of this library give you
permission to link this library with independent modules to produce an
executable, regardless of the license terms of these independent
modules, and to copy and distribute the resulting executable under
terms of your choice, provided that you also meet, for each linked
independent module, the terms and conditions of the license of that
module. An independent module is a module which is not derived from
or based on this library. If you modify this library, you may extend
this exception to your version of the library, but you are not
obligated to do so. If you do not wish to do so, delete this
exception statement from your version.