org.omg.CORBA.TCKind Maven / Gradle / Ivy
/*
* Copyright (c) 1997, 2020 Oracle and/or its affiliates.
*
* This program and the accompanying materials are made available under the
* terms of the Eclipse Public License v. 2.0 which is available at
* http://www.eclipse.org/legal/epl-2.0, or the Eclipse Distribution License
* v. 1.0 which is available at
* http://www.eclipse.org/org/documents/edl-v10.php.
*
* This Source Code may also be made available under the following Secondary
* Licenses when the conditions for such availability set forth in the Eclipse
* Public License v. 2.0 are satisfied: GNU General Public License v2.0
* w/Classpath exception which is available at
* https://www.gnu.org/software/classpath/license.html.
*
* SPDX-License-Identifier: EPL-2.0 OR BSD-3-Clause OR GPL-2.0 WITH
* Classpath-exception-2.0
*/
package org.omg.CORBA;
/**
* 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.
*/
public class TCKind {
/**
* The int constant for a null IDL data type.
*/
public static final int _tk_null = 0;
/**
* The int constant for the IDL data type void.
*/
public static final int _tk_void = 1;
/**
* The int constant for the IDL data type short.
*/
public static final int _tk_short = 2;
/**
* The int constant for the IDL data type long.
*/
public static final int _tk_long = 3;
/**
* The int constant for the IDL data type ushort.
*/
public static final int _tk_ushort = 4;
/**
* The int constant for the IDL data type ulong.
*/
public static final int _tk_ulong = 5;
/**
* The int constant for the IDL data type float.
*/
public static final int _tk_float = 6;
/**
* The int constant for the IDL data type double.
*/
public static final int _tk_double = 7;
/**
* The int constant for the IDL data type boolean.
*/
public static final int _tk_boolean = 8;
/**
* The int constant for the IDL data type char.
*/
public static final int _tk_char = 9;
/**
* The int constant for the IDL data type octet.
*/
public static final int _tk_octet = 10;
/**
* The int constant for the IDL data type any.
*/
public static final int _tk_any = 11;
/**
* The int constant for the IDL data type TypeCode.
*/
public static final int _tk_TypeCode = 12;
/**
* The int constant for the IDL data type Principal.
*/
public static final int _tk_Principal = 13;
/**
* The int constant for the IDL data type objref.
*/
public static final int _tk_objref = 14;
/**
* The int constant for the IDL data type struct.
*/
public static final int _tk_struct = 15;
/**
* The int constant for the IDL data type union.
*/
public static final int _tk_union = 16;
/**
* The int constant for the IDL data type enum.
*/
public static final int _tk_enum = 17;
/**
* The int constant for the IDL data type string.
*/
public static final int _tk_string = 18;
/**
* The int constant for the IDL data type sequence.
*/
public static final int _tk_sequence = 19;
/**
* The int constant for the IDL data type array.
*/
public static final int _tk_array = 20;
/**
* The int constant for the IDL data type alias.
*/
public static final int _tk_alias = 21;
/**
* The int constant for the IDL data type except.
*/
public static final int _tk_except = 22;
/**
* The int constant for the IDL data type longlong.
*/
public static final int _tk_longlong = 23;
/**
* The int constant for the IDL data type ulonglong.
*/
public static final int _tk_ulonglong = 24;
/**
* The int constant for the IDL data type longdouble.
*/
public static final int _tk_longdouble = 25;
/**
* The int constant for the IDL data type wchar.
*/
public static final int _tk_wchar = 26;
/**
* The int constant for the IDL data type wstring.
*/
public static final int _tk_wstring = 27;
/**
* The int constant for the IDL data type fixed.
*/
public static final int _tk_fixed = 28;
/**
* The int constant for the IDL data type value.
*/
public static final int _tk_value = 29; // orbos 98-01-18: Objects By Value
/**
* The int constant for the IDL data type value_box.
*/
public static final int _tk_value_box = 30; // orbos 98-01-18: Objects By Value
/**
* The int constant for the IDL data type native.
*/
public static final int _tk_native = 31; // Verify
/**
* The int constant for the IDL data type abstract interface.
*/
public static final int _tk_abstract_interface = 32;
/**
* The TCKind constant whose value field is
* initialized with TCKind._tk_null.
*/
public static final TCKind tk_null = new TCKind(_tk_null);
/**
* The TCKind constant whose value field is
* initialized with TCKind._tk_void.
*/
public static final TCKind tk_void = new TCKind(_tk_void);
/**
* The TCKind constant whose value field is
* initialized with TCKind._tk_short.
*/
public static final TCKind tk_short = new TCKind(_tk_short);
/**
* The TCKind constant whose value field is
* initialized with TCKind._tk_long.
*/
public static final TCKind tk_long = new TCKind(_tk_long);
/**
* The TCKind constant whose value field is
* initialized with TCKind._tk_ushort.
*/
public static final TCKind tk_ushort = new TCKind(_tk_ushort);
/**
* The TCKind constant whose value field is
* initialized with TCKind._tk_ulong.
*/
public static final TCKind tk_ulong = new TCKind(_tk_ulong);
/**
* The TCKind constant whose value field is
* initialized with TCKind._tk_float.
*/
public static final TCKind tk_float = new TCKind(_tk_float);
/**
* The TCKind constant whose value field is
* initialized with TCKind._tk_double.
*/
public static final TCKind tk_double = new TCKind(_tk_double);
/**
* The TCKind constant whose value field is
* initialized with TCKind._tk_boolean.
*/
public static final TCKind tk_boolean = new TCKind(_tk_boolean);
/**
* The TCKind constant whose value field is
* initialized with TCKind._tk_char.
*/
public static final TCKind tk_char = new TCKind(_tk_char);
/**
* The TCKind constant whose value field is
* initialized with TCKind._tk_octet.
*/
public static final TCKind tk_octet = new TCKind(_tk_octet);
/**
* The TCKind constant whose value field is
* initialized with TCKind._tk_any.
*/
public static final TCKind tk_any = new TCKind(_tk_any);
/**
* The TCKind constant whose value field is
* initialized with TCKind._tk_TypeCode.
*/
public static final TCKind tk_TypeCode = new TCKind(_tk_TypeCode);
/**
* The TCKind constant whose value field is
* initialized with TCKind._tk_Principal.
*/
public static final TCKind tk_Principal = new TCKind(_tk_Principal);
/**
* The TCKind constant whose value field is
* initialized with TCKind._tk_objref.
*/
public static final TCKind tk_objref = new TCKind(_tk_objref);
/**
* The TCKind constant whose value field is
* initialized with TCKind._tk_struct.
*/
public static final TCKind tk_struct = new TCKind(_tk_struct);
/**
* The TCKind constant whose value field is
* initialized with TCKind._tk_union.
*/
public static final TCKind tk_union = new TCKind(_tk_union);
/**
* The TCKind constant whose value field is
* initialized with TCKind._tk_enum.
*/
public static final TCKind tk_enum = new TCKind(_tk_enum);
/**
* The TCKind constant whose value field is
* initialized with TCKind._tk_string.
*/
public static final TCKind tk_string = new TCKind(_tk_string);
/**
* The TCKind constant whose value field is
* initialized with TCKind._tk_sequence.
*/
public static final TCKind tk_sequence = new TCKind(_tk_sequence);
/**
* The TCKind constant whose value field is
* initialized with TCKind._tk_array.
*/
public static final TCKind tk_array = new TCKind(_tk_array);
/**
* The TCKind constant whose value field is
* initialized with TCKind._tk_alias.
*/
public static final TCKind tk_alias = new TCKind(_tk_alias);
/**
* The TCKind constant whose value field is
* initialized with TCKind._tk_except.
*/
public static final TCKind tk_except = new TCKind(_tk_except);
/**
* The TCKind constant whose value field is
* initialized with TCKind._tk_longlong.
*/
public static final TCKind tk_longlong = new TCKind(_tk_longlong);
/**
* The TCKind constant whose value field is
* initialized with TCKind._tk_ulonglong.
*/
public static final TCKind tk_ulonglong = new TCKind(_tk_ulonglong);
/**
* The TCKind constant whose value field is
* initialized with TCKind._tk_longdouble.
*/
public static final TCKind tk_longdouble = new TCKind(_tk_longdouble);
/**
* The TCKind constant whose value field is
* initialized with TCKind._tk_wchar.
*/
public static final TCKind tk_wchar = new TCKind(_tk_wchar);
/**
* The TCKind constant whose value field is
* initialized with TCKind._tk_wstring.
*/
public static final TCKind tk_wstring = new TCKind(_tk_wstring);
/**
* The TCKind constant whose value field is
* initialized with TCKind._tk_fixed.
*/
public static final TCKind tk_fixed = new TCKind(_tk_fixed);
// orbos 98-01-18: Objects By Value -- begin
/**
* The TCKind constant whose value field is
* initialized with TCKind._tk_value.
*/
public static final TCKind tk_value = new TCKind(_tk_value);
/**
* The TCKind constant whose value field is
* initialized with TCKind._tk_value_box.
*/
public static final TCKind tk_value_box = new TCKind(_tk_value_box);
// orbos 98-01-18: Objects By Value -- end
/**
* The TCKind constant whose value field is
* initialized with TCKind._tk_native.
*/
public static final TCKind tk_native = new TCKind(_tk_native);
/**
* The TCKind constant whose value field is
* initialized with TCKind._tk_abstract_interface.
*/
public static final TCKind tk_abstract_interface = new TCKind(_tk_abstract_interface);
/**
* Retrieves the value of this TCKind instance.
*
* @return the int that represents the kind of
* IDL data type for this TCKind instance
*/
public int value() {
return _value;
}
/**
* 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
*/
public static TCKind from_int(int i) {
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();
}
}
/**
* 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.
*/
// @Deprecated
protected TCKind(int _value){
this._value = _value;
}
private int _value;
}