FileDocCategorySizeDatePackage
TCKind.javaAPI DocJava SE 5 API16928Fri Aug 26 14:58:32 BST 2005org.omg.CORBA

TCKind

public class TCKind extends Object
The Java mapping of the IDL enum TCKind, which specifies the kind of a TypeCode object. There is one kind for each primitive and essential IDL data type.

The class TCKind consists of:

  • a set of int constants, one for each kind of IDL data type. These int constants make it possible to use a switch statement.
  • a set of TCKind constants, one for each kind of IDL data type. The value field for each TCKind instance is initialized with the int constant that corresponds with the IDL data type that the instance represents.
  • the method from_intfor converting an int to its corresponding TCKind instance

    Example: 

    org.omg.CORBA.TCKind k = org.omg.CORBA.TCKind.from_int(
org.omg.CORBA.TCKind._tk_string);
    The variable k represents the TCKind instance for the IDL type string, which is tk_string.

  • the method value for accessing the _value field of a TCKind constant

    Example: 

    int i = org.omg.CORBA.TCKind.tk_char.value();
    The variable i represents 9, the value for the IDL data type char.

The value field of a TCKind instance is the CDR encoding used for a TypeCode object in an IIOP message.

Fields Summary
public static final int
_tk_null
The int constant for a null IDL data type.
public static final int
_tk_void
The int constant for the IDL data type void.
public static final int
_tk_short
The int constant for the IDL data type short.
public static final int
_tk_long
The int constant for the IDL data type long.
public static final int
_tk_ushort
The int constant for the IDL data type ushort.
public static final int
_tk_ulong
The int constant for the IDL data type ulong.
public static final int
_tk_float
The int constant for the IDL data type float.
public static final int
_tk_double
The int constant for the IDL data type double.
public static final int
_tk_boolean
The int constant for the IDL data type boolean.
public static final int
_tk_char
The int constant for the IDL data type char.
public static final int
_tk_octet
The int constant for the IDL data type octet.
public static final int
_tk_any
The int constant for the IDL data type any.
public static final int
_tk_TypeCode
The int constant for the IDL data type TypeCode.
public static final int
_tk_Principal
The int constant for the IDL data type Principal.
public static final int
_tk_objref
The int constant for the IDL data type objref.
public static final int
_tk_struct
The int constant for the IDL data type struct.
public static final int
_tk_union
The int constant for the IDL data type union.
public static final int
_tk_enum
The int constant for the IDL data type enum.
public static final int
_tk_string
The int constant for the IDL data type string.
public static final int
_tk_sequence
The int constant for the IDL data type sequence.
public static final int
_tk_array
The int constant for the IDL data type array.
public static final int
_tk_alias
The int constant for the IDL data type alias.
public static final int
_tk_except
The int constant for the IDL data type except.
public static final int
_tk_longlong
The int constant for the IDL data type longlong.
public static final int
_tk_ulonglong
The int constant for the IDL data type ulonglong.
public static final int
_tk_longdouble
The int constant for the IDL data type longdouble.
public static final int
_tk_wchar
The int constant for the IDL data type wchar.
public static final int
_tk_wstring
The int constant for the IDL data type wstring.
public static final int
_tk_fixed
The int constant for the IDL data type fixed.
public static final int
_tk_value
The int constant for the IDL data type value.
public static final int
_tk_value_box
The int constant for the IDL data type value_box.
public static final int
_tk_native
The int constant for the IDL data type native.
public static final int
_tk_abstract_interface
The int constant for the IDL data type abstract interface.
public static final TCKind
tk_null
The TCKind constant whose value field is initialized with TCKind._tk_null.
public static final TCKind
tk_void
The TCKind constant whose value field is initialized with TCKind._tk_void.
public static final TCKind
tk_short
The TCKind constant whose value field is initialized with TCKind._tk_short.
public static final TCKind
tk_long
The TCKind constant whose value field is initialized with TCKind._tk_long.
public static final TCKind
tk_ushort
The TCKind constant whose value field is initialized with TCKind._tk_ushort.
public static final TCKind
tk_ulong
The TCKind constant whose value field is initialized with TCKind._tk_ulong.
public static final TCKind
tk_float
The TCKind constant whose value field is initialized with TCKind._tk_float.
public static final TCKind
tk_double
The TCKind constant whose value field is initialized with TCKind._tk_double.
public static final TCKind
tk_boolean
The TCKind constant whose value field is initialized with TCKind._tk_boolean.
public static final TCKind
tk_char
The TCKind constant whose value field is initialized with TCKind._tk_char.
public static final TCKind
tk_octet
The TCKind constant whose value field is initialized with TCKind._tk_octet.
public static final TCKind
tk_any
The TCKind constant whose value field is initialized with TCKind._tk_any.
public static final TCKind
tk_TypeCode
The TCKind constant whose value field is initialized with TCKind._tk_TypeCode.
public static final TCKind
tk_Principal
The TCKind constant whose value field is initialized with TCKind._tk_Principal.
public static final TCKind
tk_objref
The TCKind constant whose value field is initialized with TCKind._tk_objref.
public static final TCKind
tk_struct
The TCKind constant whose value field is initialized with TCKind._tk_struct.
public static final TCKind
tk_union
The TCKind constant whose value field is initialized with TCKind._tk_union.
public static final TCKind
tk_enum
The TCKind constant whose value field is initialized with TCKind._tk_enum.
public static final TCKind
tk_string
The TCKind constant whose value field is initialized with TCKind._tk_string.
public static final TCKind
tk_sequence
The TCKind constant whose value field is initialized with TCKind._tk_sequence.
public static final TCKind
tk_array
The TCKind constant whose value field is initialized with TCKind._tk_array.
public static final TCKind
tk_alias
The TCKind constant whose value field is initialized with TCKind._tk_alias.
public static final TCKind
tk_except
The TCKind constant whose value field is initialized with TCKind._tk_except.
public static final TCKind
tk_longlong
The TCKind constant whose value field is initialized with TCKind._tk_longlong.
public static final TCKind
tk_ulonglong
The TCKind constant whose value field is initialized with TCKind._tk_ulonglong.
public static final TCKind
tk_longdouble
The TCKind constant whose value field is initialized with TCKind._tk_longdouble.
public static final TCKind
tk_wchar
The TCKind constant whose value field is initialized with TCKind._tk_wchar.
public static final TCKind
tk_wstring
The TCKind constant whose value field is initialized with TCKind._tk_wstring.
public static final TCKind
tk_fixed
The TCKind constant whose value field is initialized with TCKind._tk_fixed.
public static final TCKind
tk_value
The TCKind constant whose value field is initialized with TCKind._tk_value.
public static final TCKind
tk_value_box
The TCKind constant whose value field is initialized with TCKind._tk_value_box.
public static final TCKind
tk_native
The TCKind constant whose value field is initialized with TCKind._tk_native.
public static final TCKind
tk_abstract_interface
The TCKind constant whose value field is initialized with TCKind._tk_abstract_interface.
private int
_value
Constructors Summary
protected TCKind(int _value)
Creates a new TCKind instance initialized with the given int.

deprecated
Do not use this constructor as this method should be private according to the OMG specification. Use {@link #from_int(int)} instead.
param
_value the int to convert. It must be one of the int constants in the class TCKind.
return
a new TCKind instance whose value field matches the given int

	this._value = _value;
Methods Summary
public static org.omg.CORBA.TCKindfrom_int(int i)
Converts the given int to the corresponding TCKind instance.

param
i the int to convert. It must be one of the int constants in the class TCKind.
return
the TCKind instance whose value field matches the given int
exception
BAD_PARAM if the given int does not match the _value field of any TCKind instance

	switch (i) {
	case _tk_null:
	    return tk_null;
	case _tk_void:
	    return tk_void;
	case _tk_short:
	    return tk_short;
	case _tk_long:
	    return tk_long;
	case _tk_ushort:
	    return tk_ushort;
	case _tk_ulong:
	    return tk_ulong;
	case _tk_float:
	    return tk_float;
	case _tk_double:
	    return tk_double;
	case _tk_boolean:
	    return tk_boolean;
	case _tk_char:
	    return tk_char;
	case _tk_octet:
	    return tk_octet;
	case _tk_any:
	    return tk_any;
	case _tk_TypeCode:
	    return tk_TypeCode;
	case _tk_Principal:
	    return tk_Principal;
	case _tk_objref:
	    return tk_objref;
	case _tk_struct:
	    return tk_struct;
	case _tk_union:
	    return tk_union;
	case _tk_enum:
	    return tk_enum;
	case _tk_string:
	    return tk_string;
	case _tk_sequence:
	    return tk_sequence;
	case _tk_array:
	    return tk_array;
	case _tk_alias:
	    return tk_alias;
	case _tk_except:
	    return tk_except;
	case _tk_longlong:
	    return tk_longlong;
	case _tk_ulonglong:
	    return tk_ulonglong;
	case _tk_longdouble:
	    return tk_longdouble;
	case _tk_wchar:
	    return tk_wchar;
	case _tk_wstring:
	    return tk_wstring;
	case _tk_fixed:
	    return tk_fixed;
	case _tk_value:		// orbos 98-01-18: Objects By Value
	    return tk_value;
	case _tk_value_box:	// orbos 98-01-18: Objects By Value
	    return tk_value_box;
        case _tk_native:
            return tk_native;
        case _tk_abstract_interface:
            return tk_abstract_interface;
	default:
	    throw new org.omg.CORBA.BAD_PARAM();
	}
public intvalue()
Retrieves the value of this TCKind instance.

return
the int that represents the kind of IDL data type for this TCKind instance





                                
       
	return _value;