Package org.omg.CORBA

Class TCKind

java.lang.Object
org.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.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    The int constant for the IDL data type abstract interface.
    static final int
    The int constant for the IDL data type alias.
    static final int
    The int constant for the IDL data type any.
    static final int
    The int constant for the IDL data type array.
    static final int
    The int constant for the IDL data type boolean.
    static final int
    The int constant for the IDL data type char.
    static final int
    The int constant for the IDL data type double.
    static final int
    The int constant for the IDL data type enum.
    static final int
    The int constant for the IDL data type except.
    static final int
    The int constant for the IDL data type fixed.
    static final int
    The int constant for the IDL data type float.
    static final int
    The int constant for the IDL data type long.
    static final int
    The int constant for the IDL data type longdouble.
    static final int
    The int constant for the IDL data type longlong.
    static final int
    The int constant for the IDL data type native.
    static final int
    The int constant for a null IDL data type.
    static final int
    The int constant for the IDL data type objref.
    static final int
    The int constant for the IDL data type octet.
    static final int
    The int constant for the IDL data type Principal.
    static final int
    The int constant for the IDL data type sequence.
    static final int
    The int constant for the IDL data type short.
    static final int
    The int constant for the IDL data type string.
    static final int
    The int constant for the IDL data type struct.
    static final int
    The int constant for the IDL data type TypeCode.
    static final int
    The int constant for the IDL data type ulong.
    static final int
    The int constant for the IDL data type ulonglong.
    static final int
    The int constant for the IDL data type union.
    static final int
    The int constant for the IDL data type ushort.
    static final int
    The int constant for the IDL data type value.
    static final int
    The int constant for the IDL data type value_box.
    static final int
    The int constant for the IDL data type void.
    static final int
    The int constant for the IDL data type wchar.
    static final int
    The int constant for the IDL data type wstring.
    private int
     
    static final TCKind
    The TCKind constant whose value field is initialized with TCKind._tk_abstract_interface.
    static final TCKind
    The TCKind constant whose value field is initialized with TCKind._tk_alias.
    static final TCKind
    The TCKind constant whose value field is initialized with TCKind._tk_any.
    static final TCKind
    The TCKind constant whose value field is initialized with TCKind._tk_array.
    static final TCKind
    The TCKind constant whose value field is initialized with TCKind._tk_boolean.
    static final TCKind
    The TCKind constant whose value field is initialized with TCKind._tk_char.
    static final TCKind
    The TCKind constant whose value field is initialized with TCKind._tk_double.
    static final TCKind
    The TCKind constant whose value field is initialized with TCKind._tk_enum.
    static final TCKind
    The TCKind constant whose value field is initialized with TCKind._tk_except.
    static final TCKind
    The TCKind constant whose value field is initialized with TCKind._tk_fixed.
    static final TCKind
    The TCKind constant whose value field is initialized with TCKind._tk_float.
    static final TCKind
    The TCKind constant whose value field is initialized with TCKind._tk_long.
    static final TCKind
    The TCKind constant whose value field is initialized with TCKind._tk_longdouble.
    static final TCKind
    The TCKind constant whose value field is initialized with TCKind._tk_longlong.
    static final TCKind
    The TCKind constant whose value field is initialized with TCKind._tk_native.
    static final TCKind
    The TCKind constant whose value field is initialized with TCKind._tk_null.
    static final TCKind
    The TCKind constant whose value field is initialized with TCKind._tk_objref.
    static final TCKind
    The TCKind constant whose value field is initialized with TCKind._tk_octet.
    static final TCKind
    The TCKind constant whose value field is initialized with TCKind._tk_Principal.
    static final TCKind
    The TCKind constant whose value field is initialized with TCKind._tk_sequence.
    static final TCKind
    The TCKind constant whose value field is initialized with TCKind._tk_short.
    static final TCKind
    The TCKind constant whose value field is initialized with TCKind._tk_string.
    static final TCKind
    The TCKind constant whose value field is initialized with TCKind._tk_struct.
    static final TCKind
    The TCKind constant whose value field is initialized with TCKind._tk_TypeCode.
    static final TCKind
    The TCKind constant whose value field is initialized with TCKind._tk_ulong.
    static final TCKind
    The TCKind constant whose value field is initialized with TCKind._tk_ulonglong.
    static final TCKind
    The TCKind constant whose value field is initialized with TCKind._tk_union.
    static final TCKind
    The TCKind constant whose value field is initialized with TCKind._tk_ushort.
    static final TCKind
    The TCKind constant whose value field is initialized with TCKind._tk_value.
    static final TCKind
    The TCKind constant whose value field is initialized with TCKind._tk_value_box.
    static final TCKind
    The TCKind constant whose value field is initialized with TCKind._tk_void.
    static final TCKind
    The TCKind constant whose value field is initialized with TCKind._tk_wchar.
    static final TCKind
    The TCKind constant whose value field is initialized with TCKind._tk_wstring.
  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
    protected
    TCKind(int _value)
    Deprecated.
    Do not use this constructor as this method should be private according to the OMG specification.
  • Method Summary

    Modifier and Type
    Method
    Description
    static TCKind
    from_int(int i)
    Converts the given int to the corresponding TCKind instance.
    int
    Retrieves the value of this TCKind instance.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
  • Field Details

    • _tk_null

      public static final int _tk_null
      The int constant for a null IDL data type.
      See Also:
    • _tk_void

      public static final int _tk_void
      The int constant for the IDL data type void.
      See Also:
    • _tk_short

      public static final int _tk_short
      The int constant for the IDL data type short.
      See Also:
    • _tk_long

      public static final int _tk_long
      The int constant for the IDL data type long.
      See Also:
    • _tk_ushort

      public static final int _tk_ushort
      The int constant for the IDL data type ushort.
      See Also:
    • _tk_ulong

      public static final int _tk_ulong
      The int constant for the IDL data type ulong.
      See Also:
    • _tk_float

      public static final int _tk_float
      The int constant for the IDL data type float.
      See Also:
    • _tk_double

      public static final int _tk_double
      The int constant for the IDL data type double.
      See Also:
    • _tk_boolean

      public static final int _tk_boolean
      The int constant for the IDL data type boolean.
      See Also:
    • _tk_char

      public static final int _tk_char
      The int constant for the IDL data type char.
      See Also:
    • _tk_octet

      public static final int _tk_octet
      The int constant for the IDL data type octet.
      See Also:
    • _tk_any

      public static final int _tk_any
      The int constant for the IDL data type any.
      See Also:
    • _tk_TypeCode

      public static final int _tk_TypeCode
      The int constant for the IDL data type TypeCode.
      See Also:
    • _tk_Principal

      public static final int _tk_Principal
      The int constant for the IDL data type Principal.
      See Also:
    • _tk_objref

      public static final int _tk_objref
      The int constant for the IDL data type objref.
      See Also:
    • _tk_struct

      public static final int _tk_struct
      The int constant for the IDL data type struct.
      See Also:
    • _tk_union

      public static final int _tk_union
      The int constant for the IDL data type union.
      See Also:
    • _tk_enum

      public static final int _tk_enum
      The int constant for the IDL data type enum.
      See Also:
    • _tk_string

      public static final int _tk_string
      The int constant for the IDL data type string.
      See Also:
    • _tk_sequence

      public static final int _tk_sequence
      The int constant for the IDL data type sequence.
      See Also:
    • _tk_array

      public static final int _tk_array
      The int constant for the IDL data type array.
      See Also:
    • _tk_alias

      public static final int _tk_alias
      The int constant for the IDL data type alias.
      See Also:
    • _tk_except

      public static final int _tk_except
      The int constant for the IDL data type except.
      See Also:
    • _tk_longlong

      public static final int _tk_longlong
      The int constant for the IDL data type longlong.
      See Also:
    • _tk_ulonglong

      public static final int _tk_ulonglong
      The int constant for the IDL data type ulonglong.
      See Also:
    • _tk_longdouble

      public static final int _tk_longdouble
      The int constant for the IDL data type longdouble.
      See Also:
    • _tk_wchar

      public static final int _tk_wchar
      The int constant for the IDL data type wchar.
      See Also:
    • _tk_wstring

      public static final int _tk_wstring
      The int constant for the IDL data type wstring.
      See Also:
    • _tk_fixed

      public static final int _tk_fixed
      The int constant for the IDL data type fixed.
      See Also:
    • _tk_value

      public static final int _tk_value
      The int constant for the IDL data type value.
      See Also:
    • _tk_value_box

      public static final int _tk_value_box
      The int constant for the IDL data type value_box.
      See Also:
    • _tk_native

      public static final int _tk_native
      The int constant for the IDL data type native.
      See Also:
    • _tk_abstract_interface

      public static final int _tk_abstract_interface
      The int constant for the IDL data type abstract interface.
      See Also:
    • tk_null

      public static final TCKind tk_null
      The TCKind constant whose value field is initialized with TCKind._tk_null.
    • tk_void

      public static final TCKind tk_void
      The TCKind constant whose value field is initialized with TCKind._tk_void.
    • tk_short

      public static final TCKind tk_short
      The TCKind constant whose value field is initialized with TCKind._tk_short.
    • tk_long

      public static final TCKind tk_long
      The TCKind constant whose value field is initialized with TCKind._tk_long.
    • tk_ushort

      public static final TCKind tk_ushort
      The TCKind constant whose value field is initialized with TCKind._tk_ushort.
    • tk_ulong

      public static final TCKind tk_ulong
      The TCKind constant whose value field is initialized with TCKind._tk_ulong.
    • tk_float

      public static final TCKind tk_float
      The TCKind constant whose value field is initialized with TCKind._tk_float.
    • tk_double

      public static final TCKind tk_double
      The TCKind constant whose value field is initialized with TCKind._tk_double.
    • tk_boolean

      public static final TCKind tk_boolean
      The TCKind constant whose value field is initialized with TCKind._tk_boolean.
    • tk_char

      public static final TCKind tk_char
      The TCKind constant whose value field is initialized with TCKind._tk_char.
    • tk_octet

      public static final TCKind tk_octet
      The TCKind constant whose value field is initialized with TCKind._tk_octet.
    • tk_any

      public static final TCKind tk_any
      The TCKind constant whose value field is initialized with TCKind._tk_any.
    • tk_TypeCode

      public static final TCKind tk_TypeCode
      The TCKind constant whose value field is initialized with TCKind._tk_TypeCode.
    • tk_Principal

      public static final TCKind tk_Principal
      The TCKind constant whose value field is initialized with TCKind._tk_Principal.
    • tk_objref

      public static final TCKind tk_objref
      The TCKind constant whose value field is initialized with TCKind._tk_objref.
    • tk_struct

      public static final TCKind tk_struct
      The TCKind constant whose value field is initialized with TCKind._tk_struct.
    • tk_union

      public static final TCKind tk_union
      The TCKind constant whose value field is initialized with TCKind._tk_union.
    • tk_enum

      public static final TCKind tk_enum
      The TCKind constant whose value field is initialized with TCKind._tk_enum.
    • tk_string

      public static final TCKind tk_string
      The TCKind constant whose value field is initialized with TCKind._tk_string.
    • tk_sequence

      public static final TCKind tk_sequence
      The TCKind constant whose value field is initialized with TCKind._tk_sequence.
    • tk_array

      public static final TCKind tk_array
      The TCKind constant whose value field is initialized with TCKind._tk_array.
    • tk_alias

      public static final TCKind tk_alias
      The TCKind constant whose value field is initialized with TCKind._tk_alias.
    • tk_except

      public static final TCKind tk_except
      The TCKind constant whose value field is initialized with TCKind._tk_except.
    • tk_longlong

      public static final TCKind tk_longlong
      The TCKind constant whose value field is initialized with TCKind._tk_longlong.
    • tk_ulonglong

      public static final TCKind tk_ulonglong
      The TCKind constant whose value field is initialized with TCKind._tk_ulonglong.
    • tk_longdouble

      public static final TCKind tk_longdouble
      The TCKind constant whose value field is initialized with TCKind._tk_longdouble.
    • tk_wchar

      public static final TCKind tk_wchar
      The TCKind constant whose value field is initialized with TCKind._tk_wchar.
    • tk_wstring

      public static final TCKind tk_wstring
      The TCKind constant whose value field is initialized with TCKind._tk_wstring.
    • tk_fixed

      public static final TCKind tk_fixed
      The TCKind constant whose value field is initialized with TCKind._tk_fixed.
    • tk_value

      public static final TCKind tk_value
      The TCKind constant whose value field is initialized with TCKind._tk_value.
    • tk_value_box

      public static final TCKind tk_value_box
      The TCKind constant whose value field is initialized with TCKind._tk_value_box.
    • tk_native

      public static final TCKind tk_native
      The TCKind constant whose value field is initialized with TCKind._tk_native.
    • tk_abstract_interface

      public static final TCKind tk_abstract_interface
      The TCKind constant whose value field is initialized with TCKind._tk_abstract_interface.
    • _value

      private int _value
  • Constructor Details

    • TCKind

      protected TCKind(int _value)
      Deprecated.
      Do not use this constructor as this method should be private according to the OMG specification. Use from_int(int) instead.
      Creates a new TCKind instance initialized with the given int.
      Parameters:
      _value - the int to convert. It must be one of the int constants in the class TCKind.
  • Method Details

    • value

      public int value()
      Retrieves the value of this TCKind instance.
      Returns:
      the int that represents the kind of IDL data type for this TCKind instance
    • from_int

      public static TCKind from_int(int i)
      Converts the given int to the corresponding TCKind instance.
      Parameters:
      i - the int to convert. It must be one of the int constants in the class TCKind.
      Returns:
      the TCKind instance whose value field matches the given int
      Throws:
      BAD_PARAM - if the given int does not match the _value field of any TCKind instance