org.jacorb.orb
Class TypeCode

java.lang.Object
  org.omg.CORBA.TypeCode
      org.jacorb.orb.TypeCode

All Implemented Interfaces:

java.io.Serializable, org.omg.CORBA.portable.IDLEntity

public class TypeCode
extends org.omg.CORBA.TypeCode

JacORB implementation of CORBA TypeCodes

Version:

$Id: TypeCode.java,v 1.48 2006/07/10 13:34:12 alphonse.bendt Exp $

Author:

Gerald Brose, FU Berlin

See Also:

Serialized Form

Constructor Summary

TypeCode(int _kind)
Constructor for primitive types, called only from static initializer and org.jacorb.ir.TypeCodeUtil

TypeCode(int _kind, int _bound)
Constructor for tk_string, tk_wstring

TypeCode(int _kind, int _bound, org.omg.CORBA.TypeCode _element_type)
Constructor for tk_sequence, tk_array

TypeCode(int _kind, java.lang.String _id, java.lang.String _name)
Constructor for tk_objref, tk_abstract_interface, tk_native, tk_local_interface

TypeCode(int _kind, java.lang.String _id, java.lang.String _name, org.omg.CORBA.StructMember[] _members)
Constructor for tk_struct and tk_except

TypeCode(int _kind, java.lang.String _id, java.lang.String _name, org.omg.CORBA.TypeCode _original_type)
Constructor for tk_alias, tk_value_box

TypeCode(short _digits, short _scale)
Constructor for tk_fixed

TypeCode(java.lang.String id)
Constructor for recursive types

TypeCode(java.lang.String id, java.lang.String _name, short type_modifier, org.omg.CORBA.TypeCode concrete_base, org.omg.CORBA.ValueMember[] members)
Constructor for tk_value

TypeCode(java.lang.String _id, java.lang.String _name, java.lang.String[] _members)
Constructor for tk_enum

TypeCode(java.lang.String _id, java.lang.String _name, org.omg.CORBA.TypeCode _discriminator_type, org.omg.CORBA.UnionMember[] _members)
Constructor for tk_union

Method Summary

int	_kind()
org.omg.CORBA.TypeCode	concrete_base_type()
org.omg.CORBA.TypeCode	content_type()
static TypeCode	create_tc(java.lang.Class clazz) Creates a TypeCode for an arbitrary Java class.
int	default_index()
org.omg.CORBA.TypeCode	discriminator_type()
boolean	equal(org.omg.CORBA.TypeCode tc) check TypeCodes for equality
boolean	equivalent(org.omg.CORBA.TypeCode tc) less strict equivalence check, unwinds aliases
short	fixed_digits()
short	fixed_scale()
org.omg.CORBA.TypeCode	get_compact_typecode() get_compact_typecode returns a new TypeCode with all type and member information removed.
java.lang.String	id()
java.lang.String	idlTypeName() convenience method
static java.lang.String	idlTypeName(org.omg.CORBA.TypeCode typeCode) convenience method
boolean	is_primitive()
boolean	is_recursive()
static boolean	isRecursive(org.omg.CORBA.TypeCode typeCode)
org.omg.CORBA.TCKind	kind()
int	length()
int	member_count()
org.omg.CORBA.Any	member_label(int index)
java.lang.String	member_name(int index)
org.omg.CORBA.TypeCode	member_type(int index)
short	member_visibility(int index)
java.lang.String	name()
static org.omg.CORBA.TypeCode	originalType(org.omg.CORBA.TypeCode typeCode)
java.lang.String	toString()
short	type_modifier()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

TypeCode

public TypeCode(int _kind)

Constructor for primitive types, called only from static initializer and org.jacorb.ir.TypeCodeUtil

TypeCode

public TypeCode(java.lang.String id)

Constructor for recursive types

TypeCode

public TypeCode(int _kind,
                java.lang.String _id,
                java.lang.String _name,
                org.omg.CORBA.StructMember[] _members)

Constructor for tk_struct and tk_except

TypeCode

public TypeCode(java.lang.String _id,
                java.lang.String _name,
                org.omg.CORBA.TypeCode _discriminator_type,
                org.omg.CORBA.UnionMember[] _members)

Constructor for tk_union

TypeCode

public TypeCode(java.lang.String _id,
                java.lang.String _name,
                java.lang.String[] _members)

Constructor for tk_enum

TypeCode

public TypeCode(int _kind,
                java.lang.String _id,
                java.lang.String _name,
                org.omg.CORBA.TypeCode _original_type)

Constructor for tk_alias, tk_value_box

TypeCode

public TypeCode(int _kind,
                java.lang.String _id,
                java.lang.String _name)

Constructor for tk_objref, tk_abstract_interface, tk_native, tk_local_interface

TypeCode

public TypeCode(int _kind,
                int _bound)

Constructor for tk_string, tk_wstring

TypeCode

public TypeCode(int _kind,
                int _bound,
                org.omg.CORBA.TypeCode _element_type)

Constructor for tk_sequence, tk_array

TypeCode

public TypeCode(short _digits,
                short _scale)

Constructor for tk_fixed

TypeCode

public TypeCode(java.lang.String id,
                java.lang.String _name,
                short type_modifier,
                org.omg.CORBA.TypeCode concrete_base,
                org.omg.CORBA.ValueMember[] members)

Constructor for tk_value

Method Detail

is_primitive

public boolean is_primitive()

Returns:

True if this TypeCode represents a primitive type, false otherwise

equal

public boolean equal(org.omg.CORBA.TypeCode tc)

check TypeCodes for equality

Specified by:

equal in class org.omg.CORBA.TypeCode

kind

public org.omg.CORBA.TCKind kind()

Specified by:

kind in class org.omg.CORBA.TypeCode

_kind

public int _kind()

id

public java.lang.String id()
                    throws org.omg.CORBA.TypeCodePackage.BadKind

Specified by:

id in class org.omg.CORBA.TypeCode

Throws:

org.omg.CORBA.TypeCodePackage.BadKind

name

public java.lang.String name()
                      throws org.omg.CORBA.TypeCodePackage.BadKind

Specified by:

name in class org.omg.CORBA.TypeCode

Throws:

org.omg.CORBA.TypeCodePackage.BadKind

member_count

public int member_count()
                 throws org.omg.CORBA.TypeCodePackage.BadKind

Specified by:

member_count in class org.omg.CORBA.TypeCode

Throws:

org.omg.CORBA.TypeCodePackage.BadKind

member_name

public java.lang.String member_name(int index)
                             throws org.omg.CORBA.TypeCodePackage.BadKind,
                                    org.omg.CORBA.TypeCodePackage.Bounds

Specified by:

member_name in class org.omg.CORBA.TypeCode

Throws:

org.omg.CORBA.TypeCodePackage.BadKind

org.omg.CORBA.TypeCodePackage.Bounds

member_type

public org.omg.CORBA.TypeCode member_type(int index)
                                   throws org.omg.CORBA.TypeCodePackage.BadKind,
                                          org.omg.CORBA.TypeCodePackage.Bounds

Specified by:

member_type in class org.omg.CORBA.TypeCode

Throws:

org.omg.CORBA.TypeCodePackage.BadKind

org.omg.CORBA.TypeCodePackage.Bounds

member_label

public org.omg.CORBA.Any member_label(int index)
                               throws org.omg.CORBA.TypeCodePackage.BadKind,
                                      org.omg.CORBA.TypeCodePackage.Bounds

Specified by:

member_label in class org.omg.CORBA.TypeCode

Throws:

org.omg.CORBA.TypeCodePackage.BadKind

org.omg.CORBA.TypeCodePackage.Bounds

discriminator_type

public org.omg.CORBA.TypeCode discriminator_type()
                                          throws org.omg.CORBA.TypeCodePackage.BadKind

Specified by:

discriminator_type in class org.omg.CORBA.TypeCode

Throws:

org.omg.CORBA.TypeCodePackage.BadKind

default_index

public int default_index()
                  throws org.omg.CORBA.TypeCodePackage.BadKind

Specified by:

default_index in class org.omg.CORBA.TypeCode

Throws:

org.omg.CORBA.TypeCodePackage.BadKind

length

public int length()
           throws org.omg.CORBA.TypeCodePackage.BadKind

Specified by:

length in class org.omg.CORBA.TypeCode

Throws:

org.omg.CORBA.TypeCodePackage.BadKind

content_type

public org.omg.CORBA.TypeCode content_type()
                                    throws org.omg.CORBA.TypeCodePackage.BadKind

Specified by:

content_type in class org.omg.CORBA.TypeCode

Throws:

org.omg.CORBA.TypeCodePackage.BadKind

fixed_digits

public short fixed_digits()
                   throws org.omg.CORBA.TypeCodePackage.BadKind

Specified by:

fixed_digits in class org.omg.CORBA.TypeCode

Throws:

org.omg.CORBA.TypeCodePackage.BadKind

fixed_scale

public short fixed_scale()
                  throws org.omg.CORBA.TypeCodePackage.BadKind

Specified by:

fixed_scale in class org.omg.CORBA.TypeCode

Throws:

org.omg.CORBA.TypeCodePackage.BadKind

get_compact_typecode

public org.omg.CORBA.TypeCode get_compact_typecode()

get_compact_typecode returns a new TypeCode with all type and member information removed. RepositoryID and alias are preserved. This method effectively clones the original typecode - simpler than trying to work out what type so what to duplicate (and compact).

Specified by:

get_compact_typecode in class org.omg.CORBA.TypeCode

Returns:

an org.omg.CORBA.TypeCode value

member_visibility

public short member_visibility(int index)
                        throws org.omg.CORBA.TypeCodePackage.BadKind,
                               org.omg.CORBA.TypeCodePackage.Bounds

Specified by:

member_visibility in class org.omg.CORBA.TypeCode

Throws:

org.omg.CORBA.TypeCodePackage.BadKind

org.omg.CORBA.TypeCodePackage.Bounds

type_modifier

public short type_modifier()
                    throws org.omg.CORBA.TypeCodePackage.BadKind

Specified by:

type_modifier in class org.omg.CORBA.TypeCode

Throws:

org.omg.CORBA.TypeCodePackage.BadKind

concrete_base_type

public org.omg.CORBA.TypeCode concrete_base_type()
                                          throws org.omg.CORBA.TypeCodePackage.BadKind

Specified by:

concrete_base_type in class org.omg.CORBA.TypeCode

Throws:

org.omg.CORBA.TypeCodePackage.BadKind

equivalent

public boolean equivalent(org.omg.CORBA.TypeCode tc)

less strict equivalence check, unwinds aliases

Specified by:

equivalent in class org.omg.CORBA.TypeCode

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

is_recursive

public boolean is_recursive()

Returns:

TRUE is this TypeCode is recursive. Both the initial place holder TypeCode and the real TypeCode which replaces the place holder return TRUE.

isRecursive

public static boolean isRecursive(org.omg.CORBA.TypeCode typeCode)

Returns:

TRUE if the argument is a JacORB typecode and is recursive.

idlTypeName

public static java.lang.String idlTypeName(org.omg.CORBA.TypeCode typeCode)

convenience method

idlTypeName

public java.lang.String idlTypeName()

convenience method

originalType

public static final org.omg.CORBA.TypeCode originalType(org.omg.CORBA.TypeCode typeCode)

Returns:

the content type if the argument is an alias, or the argument itself otherwise

create_tc

public static TypeCode create_tc(java.lang.Class clazz)

Creates a TypeCode for an arbitrary Java class. Right now, this only covers RMI classes, not those derived from IDL.