omg/CORBA/Any.java

36  * An <code>Any</code> object is used as a component of a
42  * An <code>Any</code> object consists of two parts:
46  * value contained in the <code>Any</code> object.  For example,
56  * A large part of the <code>Any</code> class consists of pairs of methods
58  * <code>Any</code> object.
65  *    into the <code>value</code> field of the <code>Any</code> object.
67  *    <code>insert_X</code> also resets the <code>Any</code> object's
71  *        type <code>X</code> from the <code>Any</code> object.
76  *     <LI> the type of the element contained in the <code>Any</code> object is not
79  *     the <code>value</code> field of the <code>Any</code> object
88  * The class <code>Any</code> also has methods for
90  * for testing two <code>Any</code> objects for equality,
91  * and for reading an <code>Any</code> object from a stream or
96 abstract public class Any implements IDLEntity {
99      * Checks for equality between this <code>Any</code> object and the
100      * given <code>Any</code> object.  Two <code>Any</code> objects are
103      * @param a the <code>Any</code> object to test for equality
104      * @return  <code>true</code> if the <code>Any</code> objects are equal;
109     abstract public boolean equal(Any a);
113      * <code>Any</code> object.
116      *                about the value contained in this <code>Any</code> object
121      * Sets this <code>Any</code> object's <code>type</code> field
133      *                this <code>Any</code> object
141      * Reads off (unmarshals) the value of an <code>Any</code> object from
146      *                the value contained in this <code>Any</code> object
159      * Writes out the value of this <code>Any</code> object
165      * If this method is called on an <code>Any</code> object that has not
171      *                of this <code>Any</code> object
177      * Creates an output stream into which this <code>Any</code> object's
185      * Creates an input stream from which this <code>Any</code> object's value
197      * <code>Any</code> object's <code>value</code> field.
199      * @return the <code>short</code> stored in this <code>Any</code> object
200      * @exception BAD_OPERATION if this  <code>Any</code> object
208      * into this <code>Any</code> object's <code>value</code> field.
211      *                <code>Any</code> object
217      * <code>Any</code> object's <code>value</code> field.
219      * @return the <code>int</code> stored in this <code>Any</code> object
220      * @exception BAD_OPERATION if this  <code>Any</code> object
228      * into this <code>Any</code> object's <code>value</code> field.
231      *                <code>Any</code> object
238      * <code>Any</code> object's <code>value</code> field.
240      * @return the <code>long</code> stored in this <code>Any</code> object
241      * @exception BAD_OPERATION if this  <code>Any</code> object
249      * into this <code>Any</code> object's <code>value</code> field.
252      *                <code>Any</code> object
258      * <code>Any</code> object's <code>value</code> field.
260      * @return the <code>short</code> stored in this <code>Any</code> object
261      * @exception BAD_OPERATION if this  <code>Any</code> object
269      * into this <code>Any</code> object's <code>value</code> field.
272      *                <code>Any</code> object
278      * <code>Any</code> object's <code>value</code> field.
280      * @return the <code>int</code> stored in this <code>Any</code> object
281      * @exception BAD_OPERATION if this  <code>Any</code> object
289      * into this <code>Any</code> object's <code>value</code> field.
292      *                <code>Any</code> object
298      * <code>Any</code> object's <code>value</code> field.
300      * @return the <code>long</code> stored in this <code>Any</code> object
301      * @exception BAD_OPERATION if this  <code>Any</code> object
309      * into this <code>Any</code> object's <code>value</code> field.
312      *                <code>Any</code> object
318      * <code>Any</code> object's <code>value</code> field.
320      * @return the <code>float</code> stored in this <code>Any</code> object
321      * @exception BAD_OPERATION if this  <code>Any</code> object
329      * into this <code>Any</code> object's <code>value</code> field.
332      *                <code>Any</code> object
338      * <code>Any</code> object's <code>value</code> field.
340      * @return the <code>double</code> stored in this <code>Any</code> object
341      * @exception BAD_OPERATION if this  <code>Any</code> object
349      * into this <code>Any</code> object's <code>value</code> field.
352      *                <code>Any</code> object
358      * <code>Any</code> object's <code>value</code> field.
360      * @return the <code>boolean</code> stored in this <code>Any</code> object
361      * @exception BAD_OPERATION if this  <code>Any</code> object
369      * into this <code>Any</code> object's <code>value</code> field.
372      *                <code>Any</code> object
378      * <code>Any</code> object's <code>value</code> field.
380      * @return the <code>char</code> stored in this <code>Any</code> object
381      * @exception BAD_OPERATION if this  <code>Any</code> object
389      * into this <code>Any</code> object's <code>value</code> field.
392      *                <code>Any</code> object
400      * <code>Any</code> object's <code>value</code> field.
402      * @return the <code>char</code> stored in this <code>Any</code> object
403      * @exception BAD_OPERATION if this  <code>Any</code> object
411      * into this <code>Any</code> object's <code>value</code> field.
414      *                <code>Any</code> object
420      * <code>Any</code> object's <code>value</code> field.
422      * @return the <code>byte</code> stored in this <code>Any</code> object
423      * @exception BAD_OPERATION if this  <code>Any</code> object
431      * into this <code>Any</code> object's <code>value</code> field.
434      *                <code>Any</code> object
439      * Extracts the <code>Any</code> object in this
440      * <code>Any</code> object's <code>value</code> field.
442      * @return the <code>Any</code> object stored in this <code>Any</code> object
443      * @exception BAD_OPERATION if this <code>Any</code> object
444      *              contains something other than an <code>Any</code> object or the
447     abstract public Any      extract_any() throws BAD_OPERATION;
450      * Inserts the given <code>Any</code> object
451      * into this <code>Any</code> object's <code>value</code> field.
453      * @param a         the <code>Any</code> object to insert into this
454      *                <code>Any</code> object
456     abstract public void     insert_any(Any a);
460      * <code>Any</code> object's <code>value</code> field.
463      *         this <code>Any</code> object
464      * @exception BAD_OPERATION if this  <code>Any</code> object
473      * into this <code>Any</code> object's <code>value</code> field.
476      *                <code>Any</code> object
482      * <code>Any</code> object's <code>value</code> field.
485      *         this <code>Any</code> object
486      * @exception BAD_OPERATION if this  <code>Any</code> object
495      * into this <code>Any</code> object's <code>value</code> field.
498      *                <code>Any</code> object
504      * into this <code>Any</code> object's <code>value</code> field.
507      *                <code>Any</code> object
509      *              this <code>Any</code> object's <code>type</code> field
519      * into this <code>Any</code> object's <code>value</code> field.
522      *                <code>Any</code> object
524      *              this <code>Any</code> object and that describes
527          *            <code>Any</code> object
535      * <code>Any</code> object's <code>value</code> field.
537      * @return the <code>String</code> object stored in this <code>Any</code> object
538      * @exception BAD_OPERATION if this  <code>Any</code> object
546      * into this <code>Any</code> object's <code>value</code> field.
549      *                <code>Any</code> object
558      * <code>Any</code> object's <code>value</code> field.
560      * @return the <code>String</code> object stored in this <code>Any</code> object
561      * @exception BAD_OPERATION if this  <code>Any</code> object
569      * into this <code>Any</code> object's <code>value</code> field.
572      *                <code>Any</code> object
580      * <code>Any</code> object's <code>value</code> field.
582      * @return the <code>TypeCode</code> object stored in this <code>Any</code> object
583      * @exception BAD_OPERATION if this  <code>Any</code> object
591      * into this <code>Any</code> object's <code>value</code> field.
594      *                <code>Any</code> object
600      * <code>Any</code> object's <code>value</code> field.
603      * @return the <code>Principal</code> object stored in this <code>Any</code> object
604      * @exception BAD_OPERATION if this  <code>Any</code> object
619      * into this <code>Any</code> object's <code>value</code> field.
623      *                <code>Any</code> object
637      * Extracts a <code>Streamable</code> from this <code>Any</code> object's
641      * @return the <code>Streamable</code> stored in the <code>Any</code> object.
653      * into this <code>Any</code> object's <code>value</code> field.
657      *                <code>Any</code> object; may be a non-primitive
668      * <code>Any</code> object's <code>value</code> field.
671      *         stored in this <code>Any</code> object
672      * @exception BAD_OPERATION if this  <code>Any</code> object
688      * into this <code>Any</code> object's <code>value</code> field.
691      *                  to insert into this <code>Any</code> object
704      * into this <code>Any</code> object's <code>value</code> field.
707      *                  to insert into this <code>Any</code> object
709      *              this <code>Any</code> object's <code>type</code> field