< prev index next >

src/java.corba/share/classes/org/omg/CORBA/TypeCode.java

Print this page

        

@@ -1,7 +1,7 @@
 /*
- * Copyright (c) 1996, 2003, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 1996, 2015, Oracle and/or its affiliates. All rights reserved.
  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
  *
  * This code is free software; you can redistribute it and/or modify it
  * under the terms of the GNU General Public License version 2 only, as
  * published by the Free Software Foundation.  Oracle designates this

@@ -29,11 +29,11 @@
 import org.omg.CORBA.portable.IDLEntity;
 
 /**
  * A container for information about a specific CORBA data
  * type.
- *<P>
+ * <P>
  * <code>TypeCode</code> objects are used:
  * <UL>
  * <LI>in the Dynamic Invocation Interface -- to indicate the types
  * of the actual arguments or the type of the return value.  <BR>
  * <code>NamedValue</code> objects are used to represent arguments and

@@ -57,11 +57,11 @@
  * The <code>TypeCode</code> describing OMG IDL type
  * <code>sequence&lt;boolean, 10&gt;</code> has a <code>kind</code> field
  * with the value
  * <code>TCKind.tk_sequence</code> and also fields with the values
  * <code>boolean</code> and <code>10</code> for the
- * type of sequence elements and the length of the sequence. <p>
+ * type of sequence elements and the length of the sequence.
  * </UL>
  *
  * <code>TypeCode</code> objects can be obtained in various ways:
  * <OL>
  * <LI>from a call to the method <code>Any.insert_X</code>, where X is

@@ -162,12 +162,11 @@
  * The methods <code>parameter</code> and <code>param_count</code>,
  * which are deprecated, are not mapped.  <p>
  *
  * Java IDL extends the CORBA specification to allow all operations permitted
  * on a <code>struct</code> <code>TypeCode</code> to be permitted
- * on an <code>exception</code> <code>TypeCode</code> as well. <p>
- *
+ * on an <code>exception</code> <code>TypeCode</code> as well.
  */
 public abstract class TypeCode implements IDLEntity {
 
     /**
      * Compares this <code>TypeCode</code> object with the given one,

@@ -177,17 +176,15 @@
      *
      * @param tc                the <code>TypeCode</code> object to compare against
      * @return          <code>true</code> if the type codes are equal;
      *                <code>false</code> otherwise
      */
-
     public abstract boolean equal(TypeCode tc);
 
     /**
          * Tests to see if the given <code>TypeCode</code> object is
          * equivalent to this <code>TypeCode</code> object.
-         * <P>
          *
          *
          * @param tc the typecode to compare with this typecode
          *
          * @return <code>true</code> if the given typecode is equivalent to

@@ -218,11 +215,10 @@
      *
      * @return  the <code>TCKind</code> instance indicating the
      *            value of the <code>kind</code> field of this
      *                  <code>TypeCode</code> object
      */
-
     public abstract TCKind kind();
 
     /**
      * Retrieves the RepositoryId globally identifying the type
      * of this <code>TypeCode</code> object.

@@ -243,11 +239,10 @@
      *                or an empty string if there is no RepositoryID
      * @throws org.omg.CORBA.TypeCodePackage.BadKind if the method
      *           is invoked on an inappropriate kind of<code>TypeCode</code>
      *           object
      */
-
     public abstract String id() throws BadKind;
 
     /**
      * Retrieves the simple name identifying this <code>TypeCode</code>
      * object within its

@@ -266,11 +261,10 @@
      *                or an empty string
      * @throws org.omg.CORBA.TypeCodePackage.BadKind if the method
      *           is invoked on an inappropriate kind of<code>TypeCode</code>
      *           object
      */
-
     public abstract String name() throws BadKind;
 
     /**
      * Retrieves the number of members in the type described by
      * this <code>TypeCode</code> object.

@@ -285,11 +279,10 @@
      *
      * @throws org.omg.CORBA.TypeCodePackage.BadKind if the method
      *           is invoked on an inappropriate kind of <code>TypeCode</code>
      *           object
      */
-
     public abstract int member_count() throws BadKind;
 
     /**
      * Retrieves the simple name of the member identified by
      * the given index. Since names are local to a

@@ -310,11 +303,10 @@
      *                  the number of members constituting the type
      * @throws org.omg.CORBA.TypeCodePackage.BadKind if the method
      *           is invoked on an inappropriate kind of <code>TypeCode</code>
      *           object
      */
-
     public abstract String member_name(int index)
         throws BadKind, org.omg.CORBA.TypeCodePackage.Bounds;
 
     /**
      * Retrieves the <code>TypeCode</code> object describing the type

@@ -334,19 +326,18 @@
      *                      the number of members constituting the type
      * @throws org.omg.CORBA.TypeCodePackage.BadKind if the method
      *           is invoked on an inappropriate kind of <code>TypeCode</code>
      *           object
      */
-
     public abstract TypeCode member_type(int index)
         throws BadKind, org.omg.CORBA.TypeCodePackage.Bounds;
 
     /**
      * Retrieves the label of the union member
      * identified by the given index. For the default member,
      * the label is the zero octet.
-     *<P>
+     * <P>
      * The method <code>member_label</code> can only be invoked on union
      * <code>TypeCode</code> objects.
      *
      * @param index     index of the union member for which the
      *                label is being requested

@@ -358,11 +349,10 @@
      *                      the number of members constituting the union
      * @throws org.omg.CORBA.TypeCodePackage.BadKind if the method
      *           is invoked on a non-union <code>TypeCode</code>
      *           object
      */
-
     public abstract Any member_label(int index)
         throws BadKind, org.omg.CORBA.TypeCodePackage.Bounds;
 
     /**
      * Returns a <code>TypeCode</code> object describing

@@ -374,11 +364,10 @@
      *                the non-default member labels
      * @throws org.omg.CORBA.TypeCodePackage.BadKind if the method
      *           is invoked on a non-union <code>TypeCode</code>
      *           object
      */
-
     public abstract TypeCode discriminator_type()
         throws BadKind;
 
     /**
      * Returns the index of the

@@ -391,11 +380,10 @@
      *                  there is no default member
      * @throws org.omg.CORBA.TypeCodePackage.BadKind if the method
      *           is invoked on a non-union <code>TypeCode</code>
      *           object
      */
-
     public abstract int default_index() throws BadKind;
 
     /**
      * Returns the number of elements in the type described by
      * this <code>TypeCode</code> object.

@@ -410,11 +398,10 @@
      *                      number of elements for arrays
      * @throws org.omg.CORBA.TypeCodePackage.BadKind if the method
      *           is invoked on an inappropriate kind of <code>TypeCode</code>
      *           object
      */
-
     public abstract int length() throws BadKind;
 
     /**
      * Returns the <code>TypeCode</code> object representing the
      * IDL type for the members of the object described by this

@@ -422,11 +409,11 @@
      * For sequences and arrays, it returns the
      * element type. For aliases, it returns the original type. Note
      * that multidimensional arrays are represented by nesting
      * <code>TypeCode</code> objects, one per dimension.
      * For boxed valuetypes, it returns the boxed type.
-     *<P>
+     * <P>
      * The method <code>content_type</code> can be invoked on sequence, array,
      * alias, and boxed valuetype <code>TypeCode</code> objects.
      *
      * @return  a <code>TypeCode</code> object representing
      *            the element type for sequences and arrays, the

@@ -434,18 +421,17 @@
      *            boxed type for boxed valuetypes.
      * @throws org.omg.CORBA.TypeCodePackage.BadKind if the method
      *           is invoked on an inappropriate kind of <code>TypeCode</code>
      *           object
      */
-
     public abstract TypeCode content_type() throws BadKind;
 
 
     /**
          * Returns the number of digits in the fixed type described by this
          * <code>TypeCode</code> object. For example, the typecode for
-         * the number 3000.275d could be <code>fixed<7,3></code>, where
+     * the number 3000.275d could be <code>fixed&lt;7,3&gt;</code>, where
          * 7 is the precision and 3 is the scale.
          *
          * @return the total number of digits
      * @throws org.omg.CORBA.TypeCodePackage.BadKind if this method
      *           is invoked on an inappropriate kind of <code>TypeCode</code>

@@ -457,14 +443,14 @@
     /**
          * Returns the scale of the fixed type described by this
          * <code>TypeCode</code> object. A positive number indicates the
          * number of digits to the right of the decimal point.
          * For example, the number 3000d could have the
-         * typecode <code>fixed<4,0></code>, where the first number is
+     * typecode <code>fixed&lt;4,0&gt;</code>, where the first number is
          * the precision and the second number is the scale.
          * A negative number is also possible and adds zeroes to the
-         * left of the decimal point.  In this case, <code>fixed<1,-3></code>,
+     * left of the decimal point.  In this case, <code>fixed&lt;1,-3&gt;</code>,
          * could be the typecode for the number 3000d.
          *
          * @return the scale of the fixed type that this
          *         <code>TypeCode</code> object describes
      * @throws org.omg.CORBA.TypeCodePackage.BadKind if this method

@@ -490,11 +476,10 @@
      * @throws org.omg.CORBA.TypeCodePackage.Bounds
      *           if the given index is out of bounds
      * @see <a href="package-summary.html#unimpl"><code>CORBA</code> package
      *      comments for unimplemented features</a>
      */
-
     abstract public short member_visibility(int index)
         throws BadKind, org.omg.CORBA.TypeCodePackage.Bounds ;
 
     /**
      * Returns a constant indicating the modifier of the value type

@@ -510,11 +495,10 @@
      *           is invoked on a non-value type <code>TypeCode</code>
      *           object
      * @see <a href="package-summary.html#unimpl"><code>CORBA</code> package
      *      comments for unimplemented features</a>
      */
-
     abstract public short type_modifier() throws BadKind ;
 
     /**
      * Returns the <code>TypeCode</code> object that describes the concrete base type
      * of the value type that this <code>TypeCode</code> object describes.

@@ -526,8 +510,7 @@
      * @throws org.omg.CORBA.TypeCodePackage.BadKind if this method
      *           is invoked on a non-boxed value type <code>TypeCode</code> object
      * @see <a href="package-summary.html#unimpl"><code>CORBA</code> package
      *      comments for unimplemented features</a>
      */
-
     abstract public TypeCode concrete_base_type() throws BadKind ;
 }
< prev index next >