duke@1: /*
ohair@240:  * Copyright (c) 1997, 2010, Oracle and/or its affiliates. All rights reserved.
duke@1:  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
duke@1:  *
duke@1:  * This code is free software; you can redistribute it and/or modify it
duke@1:  * under the terms of the GNU General Public License version 2 only, as
ohair@158:  * published by the Free Software Foundation.  Oracle designates this
duke@1:  * particular file as subject to the "Classpath" exception as provided
ohair@158:  * by Oracle in the LICENSE file that accompanied this code.
duke@1:  *
duke@1:  * This code is distributed in the hope that it will be useful, but WITHOUT
duke@1:  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
duke@1:  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
duke@1:  * version 2 for more details (a copy is included in the LICENSE file that
duke@1:  * accompanied this code).
duke@1:  *
duke@1:  * You should have received a copy of the GNU General Public License version
duke@1:  * 2 along with this work; if not, write to the Free Software Foundation,
duke@1:  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
duke@1:  *
ohair@158:  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
ohair@158:  * or visit www.oracle.com if you need additional information or have any
ohair@158:  * questions.
duke@1:  */
duke@1: 
duke@1: package org.omg.CORBA;
duke@1: 
duke@1: 
duke@1: /**
duke@1:  * The Java mapping of the IDL enum <code>TCKind</code>, which
duke@1:  * specifies the kind of a <code>TypeCode</code> object.  There is
duke@1:  * one kind for each primitive and essential IDL data type.
duke@1:  * <P>
duke@1:  * The class <code>TCKind</code> consists of:
duke@1:  * <UL>
duke@1:  * <LI>a set of <code>int</code> constants, one for each
duke@1:  * kind of IDL data type.  These <code>int</code> constants
duke@1:  * make it possible to use a <code>switch</code> statement.
duke@1:  * <LI>a set of <code>TCKind</code> constants, one for each
duke@1:  * kind of IDL data type.  The <code>value</code> field for
duke@1:  * each <code>TCKind</code> instance is initialized with
duke@1:  * the <code>int</code> constant that corresponds with
duke@1:  * the IDL data type that the instance represents.
duke@1:  * <LI>the method <code>from_int</code>for converting
duke@1:  * an <code>int</code> to its
duke@1:  * corresponding <code>TCKind</code> instance
duke@1:  * <P>Example:
duke@1:  * <PRE>
duke@1:  *      org.omg.CORBA.TCKind k = org.omg.CORBA.TCKind.from_int(
duke@1:  *                         org.omg.CORBA.TCKind._tk_string);
duke@1:  * </PRE>
duke@1:  * The variable <code>k</code> represents the <code>TCKind</code>
duke@1:  * instance for the IDL type <code>string</code>, which is
duke@1:  * <code>tk_string</code>.
duke@1:  * <P>
duke@1:  * <LI>the method <code>value</code> for accessing the
duke@1:  * <code>_value</code> field of a <code>TCKind</code> constant
duke@1:  * <P>Example:
duke@1:  * <PRE>
duke@1:  *   int i = org.omg.CORBA.TCKind.tk_char.value();
duke@1:  * </PRE>
duke@1:  * The variable <code>i</code> represents 9, the value for the
duke@1:  * IDL data type <code>char</code>.
duke@1:  * </UL>
duke@1:  * <P>The <code>value</code> field of a <code>TCKind</code> instance
duke@1:  * is the CDR encoding used for a <code>TypeCode</code> object in
duke@1:  * an IIOP message.
duke@1:  */
duke@1: 
duke@1: public class TCKind {
duke@1: 
duke@1:     /**
duke@1:      * The <code>int</code> constant for a <code>null</code> IDL data type.
duke@1:      */
duke@1:     public static final int _tk_null = 0;
duke@1: 
duke@1:     /**
duke@1:      * The <code>int</code> constant for the IDL data type <code>void</code>.
duke@1:      */
duke@1:     public static final int _tk_void = 1;
duke@1: 
duke@1:     /**
duke@1:      * The <code>int</code> constant for the IDL data type <code>short</code>.
duke@1:      */
duke@1:     public static final int _tk_short = 2;
duke@1: 
duke@1:     /**
duke@1:      * The <code>int</code> constant for the IDL data type <code>long</code>.
duke@1:      */
duke@1:     public static final int _tk_long = 3;
duke@1: 
duke@1:     /**
duke@1:      * The <code>int</code> constant for the IDL data type <code>ushort</code>.
duke@1:      */
duke@1:     public static final int _tk_ushort = 4;
duke@1: 
duke@1:     /**
duke@1:      * The <code>int</code> constant for the IDL data type <code>ulong</code>.
duke@1:      */
duke@1:     public static final int _tk_ulong = 5;
duke@1: 
duke@1:     /**
duke@1:      * The <code>int</code> constant for the IDL data type <code>float</code>.
duke@1:      */
duke@1:     public static final int _tk_float = 6;
duke@1: 
duke@1:     /**
duke@1:      * The <code>int</code> constant for the IDL data type <code>double</code>.
duke@1:      */
duke@1:     public static final int _tk_double = 7;
duke@1: 
duke@1:     /**
duke@1:      * The <code>int</code> constant for the IDL data type <code>boolean</code>.
duke@1:      */
duke@1:     public static final int _tk_boolean = 8;
duke@1: 
duke@1:     /**
duke@1:      * The <code>int</code> constant for the IDL data type <code>char</code>.
duke@1:      */
duke@1:     public static final int _tk_char = 9;
duke@1: 
duke@1:     /**
duke@1:      * The <code>int</code> constant for the IDL data type <code>octet</code>.
duke@1:      */
duke@1:     public static final int _tk_octet = 10;
duke@1: 
duke@1:     /**
duke@1:      * The <code>int</code> constant for the IDL data type <code>any</code>.
duke@1:      */
duke@1:     public static final int _tk_any = 11;
duke@1: 
duke@1:     /**
duke@1:      * The <code>int</code> constant for the IDL data type <code>TypeCode</code>.
duke@1:      */
duke@1:     public static final int _tk_TypeCode = 12;
duke@1: 
duke@1:     /**
duke@1:      * The <code>int</code> constant for the IDL data type <code>Principal</code>.
duke@1:      */
duke@1:     public static final int _tk_Principal = 13;
duke@1: 
duke@1:     /**
duke@1:      * The <code>int</code> constant for the IDL data type <code>objref</code>.
duke@1:      */
duke@1:     public static final int _tk_objref = 14;
duke@1: 
duke@1:     /**
duke@1:      * The <code>int</code> constant for the IDL data type <code>struct</code>.
duke@1:      */
duke@1:     public static final int _tk_struct = 15;
duke@1: 
duke@1:     /**
duke@1:      * The <code>int</code> constant for the IDL data type <code>union</code>.
duke@1:      */
duke@1:     public static final int _tk_union = 16;
duke@1: 
duke@1:     /**
duke@1:      * The <code>int</code> constant for the IDL data type <code>enum</code>.
duke@1:      */
duke@1:     public static final int _tk_enum = 17;
duke@1: 
duke@1:     /**
duke@1:      * The <code>int</code> constant for the IDL data type <code>string</code>.
duke@1:      */
duke@1:     public static final int _tk_string = 18;
duke@1: 
duke@1:     /**
duke@1:      * The <code>int</code> constant for the IDL data type <code>sequence</code>.
duke@1:      */
duke@1:     public static final int _tk_sequence = 19;
duke@1: 
duke@1:     /**
duke@1:      * The <code>int</code> constant for the IDL data type <code>array</code>.
duke@1:      */
duke@1:     public static final int _tk_array = 20;
duke@1: 
duke@1:     /**
duke@1:      * The <code>int</code> constant for the IDL data type <code>alias</code>.
duke@1:      */
duke@1:     public static final int _tk_alias = 21;
duke@1: 
duke@1:     /**
duke@1:      * The <code>int</code> constant for the IDL data type <code>except</code>.
duke@1:      */
duke@1:     public static final int _tk_except = 22;
duke@1: 
duke@1:     /**
duke@1:      * The <code>int</code> constant for the IDL data type <code>longlong</code>.
duke@1:      */
duke@1:     public static final int _tk_longlong = 23;
duke@1: 
duke@1:     /**
duke@1:      * The <code>int</code> constant for the IDL data type <code>ulonglong</code>.
duke@1:      */
duke@1:     public static final int _tk_ulonglong = 24;
duke@1: 
duke@1:     /**
duke@1:      * The <code>int</code> constant for the IDL data type <code>longdouble</code>.
duke@1:      */
duke@1:     public static final int _tk_longdouble = 25;
duke@1: 
duke@1:     /**
duke@1:      * The <code>int</code> constant for the IDL data type <code>wchar</code>.
duke@1:      */
duke@1:     public static final int _tk_wchar = 26;
duke@1: 
duke@1:     /**
duke@1:      * The <code>int</code> constant for the IDL data type <code>wstring</code>.
duke@1:      */
duke@1:     public static final int _tk_wstring = 27;
duke@1: 
duke@1:     /**
duke@1:      * The <code>int</code> constant for the IDL data type <code>fixed</code>.
duke@1:      */
duke@1:     public static final int _tk_fixed = 28;
duke@1: 
duke@1:     /**
duke@1:      * The <code>int</code> constant for the IDL data type <code>value</code>.
duke@1:      */
duke@1:     public static final int _tk_value = 29;             // orbos 98-01-18: Objects By Value
duke@1: 
duke@1:     /**
duke@1:      * The <code>int</code> constant for the IDL data type <code>value_box</code>.
duke@1:      */
duke@1:     public static final int _tk_value_box = 30; // orbos 98-01-18: Objects By Value
duke@1: 
duke@1:     /**
duke@1:      * The <code>int</code> constant for the IDL data type <code>native</code>.
duke@1:      */
duke@1:     public static final int _tk_native = 31;        // Verify
duke@1: 
duke@1:     /**
duke@1:      * The <code>int</code> constant for the IDL data type <code>abstract interface</code>.
duke@1:      */
duke@1:     public static final int _tk_abstract_interface = 32;
duke@1: 
duke@1: 
duke@1:     /**
duke@1:      * The <code>TCKind</code> constant whose <code>value</code> field is
duke@1:      * initialized with <code>TCKind._tk_null</code>.
duke@1:      */
duke@1:     public static final TCKind tk_null = new TCKind(_tk_null);
duke@1: 
duke@1:     /**
duke@1:      * The <code>TCKind</code> constant whose <code>value</code> field is
duke@1:      * initialized with <code>TCKind._tk_void</code>.
duke@1:      */
duke@1:     public static final TCKind tk_void = new TCKind(_tk_void);
duke@1: 
duke@1:     /**
duke@1:      * The <code>TCKind</code> constant whose <code>value</code> field is
duke@1:      * initialized with <code>TCKind._tk_short</code>.
duke@1:      */
duke@1:     public static final TCKind tk_short = new TCKind(_tk_short);
duke@1: 
duke@1:     /**
duke@1:      * The <code>TCKind</code> constant whose <code>value</code> field is
duke@1:      * initialized with <code>TCKind._tk_long</code>.
duke@1:      */
duke@1:     public static final TCKind tk_long = new TCKind(_tk_long);
duke@1: 
duke@1:     /**
duke@1:      * The <code>TCKind</code> constant whose <code>value</code> field is
duke@1:      * initialized with <code>TCKind._tk_ushort</code>.
duke@1:      */
duke@1:     public static final TCKind tk_ushort = new TCKind(_tk_ushort);
duke@1: 
duke@1:     /**
duke@1:      * The <code>TCKind</code> constant whose <code>value</code> field is
duke@1:      * initialized with <code>TCKind._tk_ulong</code>.
duke@1:      */
duke@1:     public static final TCKind tk_ulong = new TCKind(_tk_ulong);
duke@1: 
duke@1:     /**
duke@1:      * The <code>TCKind</code> constant whose <code>value</code> field is
duke@1:      * initialized with <code>TCKind._tk_float</code>.
duke@1:      */
duke@1:     public static final TCKind tk_float = new TCKind(_tk_float);
duke@1: 
duke@1:     /**
duke@1:      * The <code>TCKind</code> constant whose <code>value</code> field is
duke@1:      * initialized with <code>TCKind._tk_double</code>.
duke@1:      */
duke@1:     public static final TCKind tk_double = new TCKind(_tk_double);
duke@1: 
duke@1:     /**
duke@1:      * The <code>TCKind</code> constant whose <code>value</code> field is
duke@1:      * initialized with <code>TCKind._tk_boolean</code>.
duke@1:      */
duke@1:     public static final TCKind tk_boolean = new TCKind(_tk_boolean);
duke@1: 
duke@1:     /**
duke@1:      * The <code>TCKind</code> constant whose <code>value</code> field is
duke@1:      * initialized with <code>TCKind._tk_char</code>.
duke@1:      */
duke@1:     public static final TCKind tk_char = new TCKind(_tk_char);
duke@1: 
duke@1:     /**
duke@1:      * The <code>TCKind</code> constant whose <code>value</code> field is
duke@1:      * initialized with <code>TCKind._tk_octet</code>.
duke@1:      */
duke@1:     public static final TCKind tk_octet = new TCKind(_tk_octet);
duke@1: 
duke@1:     /**
duke@1:      * The <code>TCKind</code> constant whose <code>value</code> field is
duke@1:      * initialized with <code>TCKind._tk_any</code>.
duke@1:      */
duke@1:     public static final TCKind tk_any = new TCKind(_tk_any);
duke@1: 
duke@1:     /**
duke@1:      * The <code>TCKind</code> constant whose <code>value</code> field is
duke@1:      * initialized with <code>TCKind._tk_TypeCode</code>.
duke@1:      */
duke@1:     public static final TCKind tk_TypeCode = new TCKind(_tk_TypeCode);
duke@1: 
duke@1:     /**
duke@1:      * The <code>TCKind</code> constant whose <code>value</code> field is
duke@1:      * initialized with <code>TCKind._tk_Principal</code>.
duke@1:      */
duke@1:     public static final TCKind tk_Principal = new TCKind(_tk_Principal);
duke@1: 
duke@1:     /**
duke@1:      * The <code>TCKind</code> constant whose <code>value</code> field is
duke@1:      * initialized with <code>TCKind._tk_objref</code>.
duke@1:      */
duke@1:     public static final TCKind tk_objref = new TCKind(_tk_objref);
duke@1: 
duke@1:     /**
duke@1:      * The <code>TCKind</code> constant whose <code>value</code> field is
duke@1:      * initialized with <code>TCKind._tk_struct</code>.
duke@1:      */
duke@1:     public static final TCKind tk_struct = new TCKind(_tk_struct);
duke@1: 
duke@1:     /**
duke@1:      * The <code>TCKind</code> constant whose <code>value</code> field is
duke@1:      * initialized with <code>TCKind._tk_union</code>.
duke@1:      */
duke@1:     public static final TCKind tk_union = new TCKind(_tk_union);
duke@1: 
duke@1:     /**
duke@1:      * The <code>TCKind</code> constant whose <code>value</code> field is
duke@1:      * initialized with <code>TCKind._tk_enum</code>.
duke@1:      */
duke@1:     public static final TCKind tk_enum = new TCKind(_tk_enum);
duke@1: 
duke@1:     /**
duke@1:      * The <code>TCKind</code> constant whose <code>value</code> field is
duke@1:      * initialized with <code>TCKind._tk_string</code>.
duke@1:      */
duke@1:     public static final TCKind tk_string = new TCKind(_tk_string);
duke@1: 
duke@1:     /**
duke@1:      * The <code>TCKind</code> constant whose <code>value</code> field is
duke@1:      * initialized with <code>TCKind._tk_sequence</code>.
duke@1:      */
duke@1:     public static final TCKind tk_sequence = new TCKind(_tk_sequence);
duke@1: 
duke@1:     /**
duke@1:      * The <code>TCKind</code> constant whose <code>value</code> field is
duke@1:      * initialized with <code>TCKind._tk_array</code>.
duke@1:      */
duke@1:     public static final TCKind tk_array = new TCKind(_tk_array);
duke@1: 
duke@1:     /**
duke@1:      * The <code>TCKind</code> constant whose <code>value</code> field is
duke@1:      * initialized with <code>TCKind._tk_alias</code>.
duke@1:      */
duke@1:     public static final TCKind tk_alias = new TCKind(_tk_alias);
duke@1: 
duke@1:     /**
duke@1:      * The <code>TCKind</code> constant whose <code>value</code> field is
duke@1:      * initialized with <code>TCKind._tk_except</code>.
duke@1:      */
duke@1:     public static final TCKind tk_except = new TCKind(_tk_except);
duke@1: 
duke@1:     /**
duke@1:      * The <code>TCKind</code> constant whose <code>value</code> field is
duke@1:      * initialized with <code>TCKind._tk_longlong</code>.
duke@1:      */
duke@1:     public static final TCKind tk_longlong = new TCKind(_tk_longlong);
duke@1: 
duke@1:     /**
duke@1:      * The <code>TCKind</code> constant whose <code>value</code> field is
duke@1:      * initialized with <code>TCKind._tk_ulonglong</code>.
duke@1:      */
duke@1:     public static final TCKind tk_ulonglong = new TCKind(_tk_ulonglong);
duke@1: 
duke@1:     /**
duke@1:      * The <code>TCKind</code> constant whose <code>value</code> field is
duke@1:      * initialized with <code>TCKind._tk_longdouble</code>.
duke@1:      */
duke@1:     public static final TCKind tk_longdouble = new TCKind(_tk_longdouble);
duke@1: 
duke@1:     /**
duke@1:      * The <code>TCKind</code> constant whose <code>value</code> field is
duke@1:      * initialized with <code>TCKind._tk_wchar</code>.
duke@1:      */
duke@1:     public static final TCKind tk_wchar = new TCKind(_tk_wchar);
duke@1: 
duke@1:     /**
duke@1:      * The <code>TCKind</code> constant whose <code>value</code> field is
duke@1:      * initialized with <code>TCKind._tk_wstring</code>.
duke@1:      */
duke@1:     public static final TCKind tk_wstring = new TCKind(_tk_wstring);
duke@1: 
duke@1:     /**
duke@1:      * The <code>TCKind</code> constant whose <code>value</code> field is
duke@1:      * initialized with <code>TCKind._tk_fixed</code>.
duke@1:      */
duke@1:     public static final TCKind tk_fixed = new TCKind(_tk_fixed);
duke@1: 
duke@1:     // orbos 98-01-18: Objects By Value -- begin
duke@1: 
duke@1:     /**
duke@1:      * The <code>TCKind</code> constant whose <code>value</code> field is
duke@1:      * initialized with <code>TCKind._tk_value</code>.
duke@1:      */
duke@1:     public static final TCKind tk_value = new TCKind(_tk_value);
duke@1: 
duke@1:     /**
duke@1:      * The <code>TCKind</code> constant whose <code>value</code> field is
duke@1:      * initialized with <code>TCKind._tk_value_box</code>.
duke@1:      */
duke@1:     public static final TCKind tk_value_box = new TCKind(_tk_value_box);
duke@1:     // orbos 98-01-18: Objects By Value -- end
duke@1: 
duke@1:     /**
duke@1:      * The <code>TCKind</code> constant whose <code>value</code> field is
duke@1:      * initialized with <code>TCKind._tk_native</code>.
duke@1:      */
duke@1:     public static final TCKind tk_native = new TCKind(_tk_native);
duke@1: 
duke@1:     /**
duke@1:      * The <code>TCKind</code> constant whose <code>value</code> field is
duke@1:      * initialized with <code>TCKind._tk_abstract_interface</code>.
duke@1:      */
duke@1:     public static final TCKind tk_abstract_interface = new TCKind(_tk_abstract_interface);
duke@1: 
duke@1: 
duke@1: 
duke@1: 
duke@1:     /**
duke@1:      * Retrieves the value of this <code>TCKind</code> instance.
duke@1:      *
duke@1:      * @return  the <code>int</code> that represents the kind of
duke@1:      * IDL data type for this <code>TCKind</code> instance
duke@1:      */
duke@1:     public int value() {
duke@1:         return _value;
duke@1:     }
duke@1: 
duke@1:     /**
duke@1:      * Converts the given <code>int</code> to the corresponding
duke@1:      * <code>TCKind</code> instance.
duke@1:      *
duke@1:      * @param i the <code>int</code> to convert.  It must be one of
duke@1:      *         the <code>int</code> constants in the class
duke@1:      *         <code>TCKind</code>.
duke@1:      * @return  the <code>TCKind</code> instance whose <code>value</code>
duke@1:      * field matches the given <code>int</code>
duke@1:      * @exception  BAD_PARAM  if the given <code>int</code> does not
duke@1:      * match the <code>_value</code> field of
duke@1:      * any <code>TCKind</code> instance
duke@1:      */
duke@1:     public static TCKind from_int(int i) {
duke@1:         switch (i) {
duke@1:         case _tk_null:
duke@1:             return tk_null;
duke@1:         case _tk_void:
duke@1:             return tk_void;
duke@1:         case _tk_short:
duke@1:             return tk_short;
duke@1:         case _tk_long:
duke@1:             return tk_long;
duke@1:         case _tk_ushort:
duke@1:             return tk_ushort;
duke@1:         case _tk_ulong:
duke@1:             return tk_ulong;
duke@1:         case _tk_float:
duke@1:             return tk_float;
duke@1:         case _tk_double:
duke@1:             return tk_double;
duke@1:         case _tk_boolean:
duke@1:             return tk_boolean;
duke@1:         case _tk_char:
duke@1:             return tk_char;
duke@1:         case _tk_octet:
duke@1:             return tk_octet;
duke@1:         case _tk_any:
duke@1:             return tk_any;
duke@1:         case _tk_TypeCode:
duke@1:             return tk_TypeCode;
duke@1:         case _tk_Principal:
duke@1:             return tk_Principal;
duke@1:         case _tk_objref:
duke@1:             return tk_objref;
duke@1:         case _tk_struct:
duke@1:             return tk_struct;
duke@1:         case _tk_union:
duke@1:             return tk_union;
duke@1:         case _tk_enum:
duke@1:             return tk_enum;
duke@1:         case _tk_string:
duke@1:             return tk_string;
duke@1:         case _tk_sequence:
duke@1:             return tk_sequence;
duke@1:         case _tk_array:
duke@1:             return tk_array;
duke@1:         case _tk_alias:
duke@1:             return tk_alias;
duke@1:         case _tk_except:
duke@1:             return tk_except;
duke@1:         case _tk_longlong:
duke@1:             return tk_longlong;
duke@1:         case _tk_ulonglong:
duke@1:             return tk_ulonglong;
duke@1:         case _tk_longdouble:
duke@1:             return tk_longdouble;
duke@1:         case _tk_wchar:
duke@1:             return tk_wchar;
duke@1:         case _tk_wstring:
duke@1:             return tk_wstring;
duke@1:         case _tk_fixed:
duke@1:             return tk_fixed;
duke@1:         case _tk_value:         // orbos 98-01-18: Objects By Value
duke@1:             return tk_value;
duke@1:         case _tk_value_box:     // orbos 98-01-18: Objects By Value
duke@1:             return tk_value_box;
duke@1:         case _tk_native:
duke@1:             return tk_native;
duke@1:         case _tk_abstract_interface:
duke@1:             return tk_abstract_interface;
duke@1:         default:
duke@1:             throw new org.omg.CORBA.BAD_PARAM();
duke@1:         }
duke@1:     }
duke@1: 
duke@1: 
duke@1:     /**
duke@1:     * Creates a new <code>TCKind</code> instance initialized with the given
duke@1:     * <code>int</code>.
duke@1:     * @deprecated Do not use this constructor as this method should be private
duke@1:     * according to the OMG specification. Use {@link #from_int(int)} instead.
duke@1:     *
duke@1:     * @param  _value the <code>int</code> to convert.  It must be one of
duke@1:     *         the <code>int</code> constants in the class
duke@1:     *         <code>TCKind</code>.
duke@1:     */
duke@1:     @Deprecated
duke@1:     protected TCKind(int _value){
duke@1:         this._value = _value;
duke@1:     }
duke@1:     private int _value;
duke@1: }