|
Generated by JDiff |
||||||||
PREV PACKAGE NEXT PACKAGE FRAMES NO FRAMES |
This file contains all the changes in documentation in the packageorg.omg.CORBA
as colored differences. Deletions are shownlike this, and additions are shown like this.
If no deletions or additions are shown in an entry, the HTML tags will be what has changed. The new HTML tags are shown in the differences. If no documentation existed, and then some was added in a later version, this change is noted in the appropriate class pages of differences, but the change is not shown on this page. Only changes in existing text are shown here. Similarly, documentation which was inherited from another class or interface is not shown here.
Note that an HTML error in the new documentation may cause the display of other documentation changes to be presented incorrectly. For instance, failure to close a <code> tag will cause all subsequent paragraphs to be displayed differently.
SignifiesA constant that signifies an "output" argument to an invocation meaning that the argument is being passed from the server to the client.ARG_OUT.value
is one of the possible values used to indicate the direction in which a parameter is being passed during a dynamic invocation using the Dynamic Invocation Interface (DII).The code fragment below shows a typical usage:
ORB orb = ORB.init(args null); org.omg.CORBA.NamedValue nv = orb.create_named_value( "argumentIdentifier" myAny org.omg.CORBA.ARG_OUT.value);@version 1.5 09/09/97 @see org.omg.CORBA.NamedValue @since JDK1.2
Serves as a container for any data that can be described in IDL or for any IDL primitive type. AnClass Any, boolean equal(Any)Any
object is used as a component of aNamedValue
object which provides information about arguments or return values in requests and which is used to define name/value pairs inContext
objects.An
Any
object consists of two parts:
- a data value
- a
TypeCode
object describing the type of the data value contained in theAny
object. For example aTypeCode
object for an array contains a field for the length of the array and a field for the type of elements in the array. (Note that in this case the second field of theTypeCode
object is itself aTypeCode
object.)
Checks for equality between thisClass Any, Object extract_Object()Any
object and the givenAny
object. TwoAny
objects are equal if both their values and type codes are equal. @param a theAny
object to test for equality @returntrue
if theAny
objects are equal;false
otherwise @seeCORBA
package comments for unimplemented features
Extracts theClass Any, Principal extract_Principal()org.omg.CORBA.Object
in thisAny
object'svalue
field. @return theorg.omg.CORBA.Object
stored in thisAny
object @exception BAD_OPERATION if thisAny
object contains something other than anorg.omg.CORBA.Object
or thevalue
field has not yet been set
Extracts theClass Any, TypeCode extract_TypeCode()Principal
object in thisAny
object'svalue
field. Note that the classPrincipal
has been deprecated. @return thePrincipal
object stored in thisAny
object @exception BAD_OPERATION if thisAny
object contains something other than aPrincipal
object or thevalue
field has not yet been set @deprecated Deprecated by CORBA 2.2.
Extracts theClass Any, Serializable extract_Value()TypeCode
object in thisAny
object'svalue
field. @return theTypeCode
object stored in thisAny
object @exception BAD_OPERATION if thisAny
object contains something other than aTypeCode
object or thevalue
field has not yet been set
Extracts theClass Any, Any extract_any()java.io.Serializable
object in thisAny
object'svalue
field. @return thejava.io.Serializable
object stored in thisAny
object @exception BAD_OPERATION if thisAny
object contains something other than ajava.io.Serializable
object or thevalue
field has not yet been set
Extracts theClass Any, boolean extract_boolean()Any
object in thisAny
object'svalue
field. @return theAny
object stored in thisAny
object @exception BAD_OPERATION if thisAny
object contains something other than anAny
object or thevalue
field has not yet been set
Extracts theClass Any, char extract_char()boolean
in thisAny
object'svalue
field. @return theboolean
stored in thisAny
object @exception BAD_OPERATION if thisAny
object contains something other than aboolean
or thevalue
field has not yet been set
Extracts theClass Any, double extract_double()char
in thisAny
object'svalue
field. @return thechar
stored in thisAny
object @exception BAD_OPERATION if thisAny
object contains something other than achar
or thevalue
field has not yet been set
Extracts theClass Any, BigDecimal extract_fixed()double
in thisAny
object'svalue
field. @return thedouble
stored in thisAny
object @exception BAD_OPERATION if thisAny
object contains something other than adouble
or thevalue
field has not yet been set
Extracts theClass Any, float extract_float()java.math.BigDecimal
object in thisAny
object'svalue
field. @return thejava.math.BigDecimal
object stored in thisAny
object @exception BAD_OPERATION if thisAny
object contains something other than ajava.math.BigDecimal
object or thevalue
field has not yet been set
Extracts theClass Any, int extract_long()float
in thisAny
object'svalue
field. @return thefloat
stored in thisAny
object @exception BAD_OPERATION if thisAny
object contains something other than afloat
or thevalue
field has not yet been set
Extracts theClass Any, long extract_longlong()int
in thisAny
object'svalue
field. @return theint
stored in thisAny
object @exception BAD_OPERATION if thisAny
object contains something other than anint
or thevalue
field has not yet been set
Extracts theClass Any, byte extract_octet()long
in thisAny
object'svalue
field. @return thelong
stored in thisAny
object @exception BAD_OPERATION if thisAny
object contains something other than along
or thevalue
field has not yet been set
Extracts theClass Any, short extract_short()byte
in thisAny
object'svalue
field. @return thebyte
stored in thisAny
object @exception BAD_OPERATION if thisAny
object contains something other than abyte
or thevalue
field has not yet been set
Extracts theClass Any, String extract_string()short
in thisAny
object'svalue
field. @return theshort
stored in thisAny
object @exception BAD_OPERATION if thisAny
object contains something other than ashort
or thevalue
field has not yet been set
Extracts theClass Any, int extract_ulong()String
object in thisAny
object'svalue
field. @return theString
object stored in thisAny
object @exception BAD_OPERATION if thisAny
object contains something other than aString
object or thevalue
field has not yet been set
Extracts theClass Any, long extract_ulonglong()int
in thisAny
object'svalue
field. @return theint
stored in thisAny
object @exception BAD_OPERATION if thisAny
object contains something other than anint
or thevalue
field has not yet been set
Extracts theClass Any, short extract_ushort()long
in thisAny
object'svalue
field. @return thelong
stored in thisAny
object @exception BAD_OPERATION if thisAny
object contains something other than along
or thevalue
field has not yet been set
Extracts theClass Any, char extract_wchar()short
in thisAny
object'svalue
field. @return theshort
stored in thisAny
object @exception BAD_OPERATION if thisAny
object contains something other than ashort
or thevalue
field has not yet been set
Extracts theClass Any, String extract_wstring()char
in thisAny
object'svalue
field. @return thechar
stored in thisAny
object @exception BAD_OPERATION if thisAny
object contains something other than achar
or thevalue
field has not yet been set
Extracts theClass Any, void insert_Object(Object, TypeCode)String
object in thisAny
object'svalue
field. @return theString
object stored in thisAny
object @exception BAD_OPERATION if thisAny
object contains something other than aString
object or thevalue
field has not yet been set
Inserts the givenClass Any, void insert_Value(Serializable, TypeCode)org.omg.CORBA.Object
object into thisAny
object'svalue
field. @param o theorg.omg.CORBA.Object
instance to insert into thisAny
object @param t theTypeCode
object that is to be inserted into thisAny
object and that describes theObject
being inserted @exception BAD_OPERATION if this method is invalid for thisAny
object
Inserts the givenClass Any, void insert_char(char)java.io.Serializable
object into thisAny
object'svalue
field. @param v thejava.io.Serializable
object to insert into thisAny
object @param t theTypeCode
object that is to be inserted into thisAny
object'stype
field and that describes thejava.io.Serializable
object being inserted @throws MARSHAL if the ORB has a problem marshalling or unmarshalling parameters
Inserts the givenClass Any, void insert_string(String)char
into thisAny
object'svalue
field. @param c thechar
to insert into thisAny
object @exception DATA_CONVERSION if there is a data conversion error
Inserts the givenClass Any, void insert_wstring(String)String
object into thisAny
object'svalue
field. @param s theString
object to insert into thisAny
object @exception DATA_CONVERSION if there is a data conversion error @exception MARSHAL if the ORB has a problem marshalling or unmarshalling parameters
Inserts the givenClass Any, TypeCode type()String
object into thisAny
object'svalue
field. @param s theString
object to insert into thisAny
object @exception MARSHAL if the ORB has a problem marshalling or unmarshalling parameters
Returns type information for the element contained in thisAny
object. @return theTypeCode
object containing type information about the value contained in thisAny
object.
Creates aCompletionStatus
object from the givenint
. @param i one of_COMPLETED_YES
_COMPLETED_NO
or_COMPLETED_MAYBE
@return one of the possibleCompletionStatus
objects with values:_COMPLETED_YES
_COMPLETED_NO
or_COMPLETED_MAYBE
@exception org.omg.CORBA.BAD_PARAM if the argument given is not one of theint
constants defined inCompletionStatus
Retrieves theClass Context, void set_values(NVList)NamedValue
objects whosename
field matches the given name or name pattern. This method allows for wildcard searches which means that there can be multiple matches and therefore multiple values returned. If the property is not found at the indicated level the search continues up the context object tree until a match is found or allContext
objects in the chain have been exhausted.If no match is found an error is returned and no property list is returned. @param start_scope a
String
object indicating the context object level at which to initiate the search for the specified properties (for example "_USER" "_GROUP" "_SYSTEM"). Valid scope names are implementation-specific. If a scope name is omitted the search begins with the specified context object. If the specified scope name is not found an exception is returned. @param op_flags an operation flag. The one flag that may be specified isCTX_RESTRICT_SCOPE
. If this flag is specified searching is limited to the specifiedstart_scope
or thisContext
object. @param pattern the property name whose values are to be retrieved.pattern
may be a name or a name with a trailing wildcard character ("*"). @return anNVList
containing all the property values (in the form ofNamedValue
objects) whose associated property name matches the given name or name pattern @see org.omg.CORBA.NamedValue
I Sets one or more property values in thisContext
object. TheNVList
supplied to this method contains one or moreNamedValue
objects. In eachNamedValue
object thename
field holds the name of the property and theflags
field must be set to zero. TheNamedValue
object'svalue
field contains anAny
object which in turn contains the value for the property. Since the value is always a string theAny
object must have thekind
field of itsTypeCode
set toTCKind.tk_string
. @param values an NVList containing the property names and associated values to be set @see org.omg.CORBA.NamedValue @see org.omg.CORBA.Any
An interface that makes it possible to access information associated with a particular thread of execution such as security information or a transaction identifier. An ORB or CORBA service that needs its own thread-specific state extends theorg/omg/CORBApackage's/Current.Users of the service can obtain an instance of the appropriate CurrentjavainterfaceGenerated byinvoking ORB.resolve_initial_references. For exampletheSecurity service obtains the Current relevantIDL-toit by invoking-Java compilerORB.resolve_initial_references("SecurityCurrent"portable); A CORBA service does not have touseversionthis method of keeping context but may choose to do so"3.Methods on classes that implement from Current access state associated with the thread in which they are invoked not state associated with the thread0" fromwhich the Current was obtained.Current objects must not be exported to other processes or externalized with ORB.object_to_string/.If any attempt is made to do so the offending operation will raise a MARSHAL system exception./../../../src/share/classes/org/omg/PortableServer/corba.idl@seeSaturdayportableJulypackage comments17 1999for12:26:21unimplementedAMfeaturesPDT.
Class DefinitionKind, DefinitionKind from_int(int)ThisThe classdefinesthat provides the constants used to identify the type of an Interface Repository object. This class contains two kinds of constants those that are anint
and those that are an instance of the classDefinitionKind
. This class provides the methodfrom_int
which given one of theint
constants creates the correspondingDefinitionKind
instance. It also provides the methodvalue
which returns theint
constant that is the value for aDefinitionKind
instance. @see IRObject
Class DefinitionKind, int value()Returns theCreates aDefinitionKind
instance corresponding to the given code . @param i one of theint
constants from the classDefinitionKind
@return theDefinitionKind
instance corresponding to the given code @throws org.omg.CORBA.BAD_PARAM if the given parameter is not one ofatheint
constants from the classDefinitionKind
.
Returns theClass DefinitionKind, DefinitionKind dk_allcodeint
constant identifying the type of an IR object. @return thecodeint
constant from the classDefinitionKind
that is the value of thisDefinitionKind
instance.
The wildcarddefinitionDefinitionKind
kindconstant useful in all occasions where anyDefinitionKind
is appropriate. TheContainersContainer'scontents
method makes use of this constant to return all contained definitions of any kind.
Class DynAny, void assign(DynAny)An object that enables the dynamic management of Any valuesorg.A DynAny object allows a program to use an Any object when the program has no static information about the type of the Any objectomg.The DynAny interface provides methods for traversing the data value associated with anCORBA.Anyobject at runtime and for extracting thevalues can be dynamically interpretedprimitive(traversed)constituents of the data valueand constructed through DynAny objects.A DynAny object is associated with a data valuethatwhich may correspond to a copy of the value inserted into an Anyobject. TheDynAny object may be seen as owning a pointer to an external buffer that holds some representation of the data value. For data values that are constructed types (IDL struct sequence array union and so on) theDynAnyobject also can be thought of as holding a pointer to a buffer offset where the current component of the constructed type is being represented.The buffer pointer effectively points to theAPIsspace usedenable traversalto represent the first componentof the data valuewhen the programmer creates the DynAny object. Calling the DynAny method next will move the pointer to the next component making it possible to iterate through the components of a constructed data value. The buffer pointer is moved back to the first component each time the method rewind is called. DynAny methods make it possible to do the following: Obtain the type codeassociated witha DynAny object Initialize a DynAny object from another DynAny object Initialize a DynAny object from an Any value Generatean Anyvalue from a DynAny object Destroy a DynAny object Create a copy of a DynAny object Access a value of some basic type in a DynAny object Iterate through components of a DynAny object Inserting a basic data type value into a constructed DynAny object implies initializing the next component of the constructed data value associated with the DynAny object. For example invoking the method insert_boolean in a DynStruct implies inserting a boolean data value as the next member of the associated struct data value. Creating a DynAny object can be done by: invoking a method on an existing DynAny object invoking an org.omg.CORBA.ORBmethodat(create_dyn_any create_dyn_struct create_dyn_sequenceruntime andso on) Dynamic creation of an Any object containing a value of a basic data type typically involves the following: Creating a DynAny object using ORB.create_basic_dyn_any passing it the type code associated with the basic data type value to be created Initializing the value by means of invoking methods on the resulting DynAny object (insert_boolean if the DynAny isextraction oftype boolean for example) Creating the Any object by invoking the method to_any ontheinitialized DynAny object Dynamic creation of an Any object containing aprimitivevalueconstituents ofa constructed data type typically involves the following: Creating a DynAny object using the appropriate ORB method (for example ORB.create_dyn_struct for an IDL struct) passing itthetype code associated with the constructeddatatype value to be created Initializing components of thevalueby means of: invoking methods on the resulting DynStruct (or other constructed type) object call the method current_component to get a DynAny object for that component call the appropriate insert method on the DynAny object returned by the method current_component to initialize the component call the method next to move to the next component and continue to get the current component initialize it and move to the next component until there are no more components (the method next returns false) or invoking methods on the DynAny objects generated for each member of the constructed type Creating the Any object by invoking the method to_any on the initialized DynAny object DynAny objects are intended to be local to the process in which they are created and used. Any method that attempts to export references to DynAny objects to other processes or to externalize them with the method org.omg.CORBA.ORB.object_to_string will throw a MARSHAL exception. Also even though DynAny objects are derived from the interface Object invoking methods from Object will throw the NO_IMPLEMENT exception. An attempt to use a DynAny object with the DII (Dynamic Invocation Interface) may throw a NO_IMPLEMENT exception. The following classes are derived from DynAny and define additional methods relevant to their particular IDL type: DynFixed DynStruct DynSequence DynArray DynUnion DynEnum DynAny and DynValue.
Class DynAny, DynAny copy()InitializesCopy thevaluecontentsassociated withfrom onethis DynAny object with the value associatedDynamicwithAnythe given DynAnyintoobjectanother. @param dyn_any theDynAny
object whosevalue willcontentsbe usedare assigned toinitializethisDynAny
object. @exceptionthrowsorg.omg.CORBA.DynAnyPackage.Invalid if thegivensourceDynAny
object has a type code thatisnot equivalent or has not been assigned a valueinvalid
Class DynAny, DynAny current_component()CloneClones thisDnyAnyDynAny
object. @returnthea copy of thisDynAny
.object
Returns aClass DynAny, void from_any(Any)DynAny
object reference that can be used to get/set the value of the component currently accessed. The appropriateorinsert
method can be called on the resultingDynAny
object to initialize the component. The appropriateget
method can be called on the resultingDynAny
object to extract the value of the component. @return aDynAny
object reference that can be used to retrieve or set the value of the component currently accessed
Class DynAny, Any get_any()InitializesMakethe value associated with thisaDynAny
objectwith the value associated withfromthe givenanAny
object. @param value theAny
objectwhose value will be used to initialize this DynAny object. @exceptionthrowsorg.omg.CORBA.DynAnyPackage.Invalid if thegivensourceAny
objecthas a type code thatisnot equivalentempty orhas not been assigned a valuebad
Retrieves theClass DynAny, boolean get_boolean()org.omg.CORBA.Any
contained in thisDynAny
object. @return theorg.omg.CORBA.Any
that is the value for thisDynAny
object @exceptionthrows org.omg.CORBA.DynAnyPackage.TypeMismatch if the type code of the accessed component in thisDynAny
object is not equivalent to the type code foraanorg.omg.CORBA.Any
Retrieves theClass DynAny, char get_char()boolean
contained in thisDynAny
object. @return theboolean
that is the value for thisDynAny
object @exceptionthrows org.omg.CORBA.DynAnyPackage.TypeMismatch if the type code of the accessed component in thisDynAny
object is not equivalent to the type code for aboolean
Retrieves theClass DynAny, double get_double()char
contained in thisDynAny
object. @return thechar
that is the value for thisDynAny
object @exceptionthrows org.omg.CORBA.DynAnyPackage.TypeMismatch if the type code of the accessed component in thisDynAny
object is not equivalent to the type code for achar
Retrieves theClass DynAny, float get_float()double
contained in thisDynAny
object. @return thedouble
that is the value for thisDynAny
object @exceptionthrows org.omg.CORBA.DynAnyPackage.TypeMismatch if the type code of the accessed component in thisDynAny
object is not equivalent to the type code for adouble
Retrieves theClass DynAny, int get_long()float
contained in thisDynAny
object. @return thefloat
that is the value for thisDynAny
object @exceptionthrows org.omg.CORBA.DynAnyPackage.TypeMismatch if the type code of the accessed component in thisDynAny
object is not equivalent to the type code for afloat
Retrieves theClass DynAny, long get_longlong()int
contained in thisDynAny
object. @return theint
that is the value for thisDynAny
object @exceptionthrows org.omg.CORBA.DynAnyPackage.TypeMismatch if the type code of the accessed component in thisDynAny
object is not equivalent to the type code for aint
Retrieves theClass DynAny, byte get_octet()long
contained in thisDynAny
object. @return thelong
that is the value for thisDynAny
object @exceptionthrows org.omg.CORBA.DynAnyPackage.TypeMismatch if the type code of the accessed component in thisDynAny
object is not equivalent to the type code for along
Retrieves theClass DynAny, Object get_reference()byte
contained in thisDynAny
object. @return thebyte
that is the value for thisDynAny
object @exceptionthrows org.omg.CORBA.DynAnyPackage.TypeMismatch if the type code of the accessed component in thisDynAny
object is not equivalent to the type code for abyte
Retrieves theClass DynAny, short get_short()org.omg.CORBA.Other
contained in thisDynAny
object. @return theorg.omg.CORBA.Other
that is the value for thisDynAny
object @exceptionthrows org.omg.CORBA.DynAnyPackage.TypeMismatch if the type code of the accessed component in thisDynAny
object is not equivalent to the type code for anorg.omg.CORBA.Other
Retrieves theClass DynAny, String get_string()short
contained in thisDynAny
object. @return theshort
that is the value for thisDynAny
object @exceptionthrows org.omg.CORBA.DynAnyPackage.TypeMismatch if the type code of the accessed component in thisDynAny
object is not equivalent to the type code for ashort
Retrieves theClass DynAny, TypeCode get_typecode()String
contained in thisDynAny
object. @return theString
that is the value for thisDynAny
object @exceptionthrows org.omg.CORBA.DynAnyPackage.TypeMismatch if the type code of the accessed component in thisDynAny
object is not equivalent to the type code for aString
Retrieves theClass DynAny, int get_ulong()org.omg.CORBA.TypeCode
contained in thisDynAny
object. @return theorg.omg.CORBA.TypeCode
that is the value for thisDynAny
object @exceptionthrows org.omg.CORBA.DynAnyPackage.TypeMismatch if the type code of the accessed component in thisDynAny
object is not equivalent to the type code for aorg.omg.CORBA.TypeCode
Retrieves theClass DynAny, long get_ulonglong()int
contained in thisDynAny
object. @return theint
that is the value for thisDynAny
object @exceptionthrows org.omg.CORBA.DynAnyPackage.TypeMismatch if the type code of the accessed component in thisDynAny
object is not equivalent to the type code for aint
Retrieves theClass DynAny, short get_ushort()long
contained in thisDynAny
object. @return thelong
that is the value for thisDynAny
object @exceptionthrows org.omg.CORBA.DynAnyPackage.TypeMismatch if the type code of the accessed component in thisDynAny
object is not equivalent to the type code for along
Retrieves theClass DynAny, Serializable get_val()short
contained in thisDynAny
object. @return theshort
that is the value for thisDynAny
object @exceptionthrows org.omg.CORBA.DynAnyPackage.TypeMismatch if the type code of the accessed component in thisDynAny
object is not equivalent to the type code for ashort
Retrieves theClass DynAny, char get_wchar()java.io.Serializable
object contained in thisDynAny
object. @return thejava.io.Serializable
object that is the value for thisDynAny
object @exceptionthrows org.omg.CORBA.DynAnyPackage.TypeMismatch if the type code of the accessed component in thisDynAny
object is not equivalent to the type code for ajava.io.Serializable
object
Retrieves theClass DynAny, String get_wstring()char
contained in thisDynAny
object. @return thechar
that is the value for thisDynAny
object @exceptionthrows org.omg.CORBA.DynAnyPackage.TypeMismatch if the type code of the accessed component in thisDynAny
object is not equivalent to the type code for achar
Retrieves theClass DynAny, void insert_any(Any)String
contained in thisDynAny
object. @return theString
that is the value for thisDynAny
object @exceptionthrows org.omg.CORBA.DynAnyPackage.TypeMismatch if the type code of the accessed component in thisDynAny
object is not equivalent to the type code for aString
Inserts the givenClass DynAny, void insert_boolean(boolean)org.omg.CORBA.Any
object as the value for thisDynAny
object.If this method is called on a constructed
DynAny
object it initializes the next component of the constructed data value associated with thisDynAny
object. @param value theorg.omg.CORBA.Any
object to insert into thisDynAny
object @exceptionthrows org.omg.CORBA.DynAnyPackage.InvalidValue if the value inserted is not consistent with the type of the accessed component in thisDynAny
object
Inserts the givenClass DynAny, void insert_char(char)boolean
as the value for thisDynAny
object.If this method is called on a constructed
DynAny
object it initializes the next component of the constructed data value associated with thisDynAny
object. @param value theboolean
to insert into thisDynAny
object @exceptionthrows org.omg.CORBA.DynAnyPackage.InvalidValue if the value inserted is not consistent with the type of the accessed component in thisDynAny
object
Inserts the givenClass DynAny, void insert_double(double)char
as the value for thisDynAny
object.If this method is called on a constructed
DynAny
object it initializes the next component of the constructed data value associated with thisDynAny
object. @param value thechar
to insert into thisDynAny
object @exceptionthrows org.omg.CORBA.DynAnyPackage.InvalidValue if the value inserted is not consistent with the type of the accessed component in thisDynAny
object
Inserts the givenClass DynAny, void insert_float(float)double
as the value for thisDynAny
object.If this method is called on a constructed
DynAny
object it initializes the next component of the constructed data value associated with thisDynAny
object. @param value thedouble
to insert into thisDynAny
object @exceptionthrows org.omg.CORBA.DynAnyPackage.InvalidValue if the value inserted is not consistent with the type of the accessed component in thisDynAny
object
Inserts the givenClass DynAny, void insert_long(int)float
as the value for thisDynAny
object.If this method is called on a constructed
DynAny
object it initializes the next component of the constructed data value associated with thisDynAny
object. @param value thefloat
to insert into thisDynAny
object @exceptionthrows org.omg.CORBA.DynAnyPackage.InvalidValue if the value inserted is not consistent with the type of the accessed component in thisDynAny
object
Inserts the givenClass DynAny, void insert_longlong(long)int
as the value for thisDynAny
object.If this method is called on a constructed
DynAny
object it initializes the next component of the constructed data value associated with thisDynAny
object. @param value theint
to insert into thisDynAny
object @exceptionthrows org.omg.CORBA.DynAnyPackage.InvalidValue if the value inserted is not consistent with the type of the accessed component in thisDynAny
object
Inserts the givenClass DynAny, void insert_octet(byte)long
as the value for thisDynAny
object.If this method is called on a constructed
DynAny
object it initializes the next component of the constructed data value associated with thisDynAny
object. @param value thelong
to insert into thisDynAny
object @exceptionthrows org.omg.CORBA.DynAnyPackage.InvalidValue if the value inserted is not consistent with the type of the accessed component in thisDynAny
object
Inserts the givenClass DynAny, void insert_reference(Object)byte
as the value for thisDynAny
object.If this method is called on a constructed
DynAny
object it initializes the next component of the constructed data value associated with thisDynAny
object. @param value thebyte
to insert into thisDynAny
object @exceptionthrows org.omg.CORBA.DynAnyPackage.InvalidValue if the value inserted is not consistent with the type of the accessed component in thisDynAny
object
Inserts the givenClass DynAny, void insert_short(short)org.omg.CORBA.Object
as the value for thisDynAny
object.If this method is called on a constructed
DynAny
object it initializes the next component of the constructed data value associated with thisDynAny
object. @param value theorg.omg.CORBA.Object
to insert into thisDynAny
object @exceptionthrows org.omg.CORBA.DynAnyPackage.InvalidValue if the value inserted is not consistent with the type of the accessed component in thisDynAny
object
Inserts the givenClass DynAny, void insert_string(String)short
as the value for thisDynAny
object.If this method is called on a constructed
DynAny
object it initializes the next component of the constructed data value associated with thisDynAny
object. @param value theshort
to insert into thisDynAny
object @exceptionthrows org.omg.CORBA.DynAnyPackage.InvalidValue if the value inserted is not consistent with the type of the accessed component in thisDynAny
object
Inserts the givenClass DynAny, void insert_typecode(TypeCode)String
object as the value for thisDynAny
object.If this method is called on a constructed
DynAny
object it initializes the next component of the constructed data value associated with thisDynAny
object. @param value theString
to insert into thisDynAny
object @exceptionthrows org.omg.CORBA.DynAnyPackage.InvalidValue if the value inserted is not consistent with the type of the accessed component in thisDynAny
object
Inserts the givenClass DynAny, void insert_ulong(int)org.omg.CORBA.TypeCode
as the value for thisDynAny
object.If this method is called on a constructed
DynAny
object it initializes the next component of the constructed data value associated with thisDynAny
object. @param value theorg.omg.CORBA.TypeCode
to insert into thisDynAny
object @exceptionthrows org.omg.CORBA.DynAnyPackage.InvalidValue if the value inserted is not consistent with the type of the accessed component in thisDynAny
object
Inserts the givenClass DynAny, void insert_ulonglong(long)int
as the value for thisDynAny
object.If this method is called on a constructed
DynAny
object it initializes the next component of the constructed data value associated with thisDynAny
object. @param value theint
to insert into thisDynAny
object @exceptionthrows org.omg.CORBA.DynAnyPackage.InvalidValue if the value inserted is not consistent with the type of the accessed component in thisDynAny
object
Inserts the givenClass DynAny, void insert_ushort(short)long
as the value for thisDynAny
object.If this method is called on a constructed
DynAny
object it initializes the next component of the constructed data value associated with thisDynAny
object. @param value thelong
to insert into thisDynAny
object @exceptionthrows org.omg.CORBA.DynAnyPackage.InvalidValue if the value inserted is not consistent with the type of the accessed component in thisDynAny
object
Inserts the givenClass DynAny, void insert_val(Serializable)short
as the value for thisDynAny
object.If this method is called on a constructed
DynAny
object it initializes the next component of the constructed data value associated with thisDynAny
object. @param value theshort
to insert into thisDynAny
object @exceptionthrows org.omg.CORBA.DynAnyPackage.InvalidValue if the value inserted is not consistent with the type of the accessed component in thisDynAny
object
Inserts the givenClass DynAny, void insert_wchar(char)java.io.Serializable
object as the value for thisDynAny
object.If this method is called on a constructed
DynAny
object it initializes the next component of the constructed data value associated with thisDynAny
object. @param value thejava.io.Serializable
object to insert into thisDynAny
object @exceptionthrows org.omg.CORBA.DynAnyPackage.InvalidValue if the value inserted is not consistent with the type of the accessed component in thisDynAny
object
Inserts the givenClass DynAny, void insert_wstring(String)char
as the value for thisDynAny
object.If this method is called on a constructed
DynAny
object it initializes the next component of the constructed data value associated with thisDynAny
object. @param value thechar
to insert into thisDynAny
object @exceptionthrows org.omg.CORBA.DynAnyPackage.InvalidValue if the value inserted is not consistent with the type of the accessed component in thisDynAny
object
Inserts the givenClass DynAny, Any to_any()String
as the value for thisDynAny
object.If this method is called on a constructed
DynAny
object it initializes the next component of the constructed data value associated with thisDynAny
object. @param value theString
to insert into thisDynAny
object @exceptionthrows org.omg.CORBA.DynAnyPackage.InvalidValue if the value inserted is not consistent with the type of the accessed component in thisDynAny
object
Class DynAny, TypeCode type()CreatesConvertan Any object from this DynAny object. The type code and value of thisaDynAny
objectare copied into thetonewly-createdanAny
object. @return thenewly-createdAny
object. @exceptionthrowsorg.omg.CORBA.DynAnyPackage.Invalid if thisDynAny
object hasisnot beenempty orcorrectlybad. created or does not contain a meaningful value
RetrievesReturns theTypeCode
object contained in this DynAny object. Note thatof thetype code associated with a DynAnyobjectis initialized at the time DynAny is created and cannot be changed duringinsertedthe lifetime ofintothethisDynAny
object. @return theTypeCode
objectdescribing the value contained in this DynAny object.
Class DynArray, void set_elements(Any[])ReturnReturns the value of all the elements ofthethis array. @returnanthe array ofAny
s.objects that is the value for thisDynArray
object @see #set_elements
SetSets thevaluesvalue ofall elements ofthisanDynArray
array represented by thisobject to the givenDynArrayarray. @param value the array ofAny
s.objects @exception InvalidSeq if the sequence is bad.@see #get_elements
Class DynFixed, byte[] get_value()TheRepresentsDynFixed interface representsaDynAny
objectwhichthat is associated with an IDL fixed type.
Class DynFixed, void set_value(byte[])ReturnReturns the value of the fixed type represented inthethisDynFixed
object. @return the value as a byte array @see #set_value
SetSets thevalue of thegiven fixed type instanceintoas the value for thisDynFixed
object. @param val the value of the fixed type as a byte array @throws org.omg.CORBA.DynAnyPackage.InvalidValue if the given argument is bad @see #get_value
TheClass DynSequence, Any[] get_elements()DynArray interfacerepresentation ofrepresentsaDynAny
objectwhichthat is associated with an IDL sequence.
Class DynSequence, int length()ReturnReturnsallthe value ofall elementsevery element in this sequence. @return an array ofAny
s.objects containing the values in the sequence @see #set_elements
Class DynSequence, void length(int)ReturnReturns the length of the sequence representedinby thisDynFixed
object. @returnan integerthe length.of the sequence
Class DynSequence, void set_elements(Any[])SetSets the length of the sequence representedinby thisDynFixed
object to the given argument. @param arg the length.of the sequence
SetSets the values of all elements in this sequence with the given array. @param value the array ofAny
s.objects to be set @exception InvalidSeqis thrownif the array of values is bad.@see #get_elements
TheClass DynStruct, TCKind current_member_kind()DynStruct interfacerepresentation ofrepresentsaDynAny
objectwhichthat is associated with an IDL struct.
Class DynStruct, String current_member_name()ReturnReturns theobject that describes the kind of the current member. @return the
TypeCodeTCKindTCKind
object that describes the current member.
During a traversalClass DynStruct, NameValuePair[] get_members()returnreturns the name of the current member. @return the string name of the current member.
Class DynStruct, void set_members(NameValuePair[])ReturnReturns an arrayofcontaining all the members of the stored struct. @return the array of name-value pairs.@see #set_members
Set the members of the struct. @param value the array of name-value pairs. @throws org.omg.CORBA.DynAnyPackage.InvalidSeq if the given argument is invalid @see #get_members
Class DynValue, String current_member_name()ReturnReturns the
TypeCodeTCKindkindobject thatofdescribes the current member. @return theTCKind
object corresponding to the current member.
Class DynValue, NameValuePair[] get_members()ReturnReturns the name of the current member while traversing aDynAny
whichobject that represents a Value object. @return the name of the current member.
Class DynValue, void set_members(NameValuePair[])ReturnReturns an array containing all the members of the value object stored in thisDynValue
. @return an array of name-value pairs. @see #set_members
SetSets the members ofathe value object thisDynValue
object represents to the given array ofNameValuePair
objects. @param value the array of name-value pairs to be set @throws org.omg.CORBA.DynAnyPackage.InvalidSeq if an inconsistent value is part of the given array @see #get_members
Connects the given servant object (a Java object that is an instance of the server implementation class) to the ORB. The servant class must extend theClass ORB, TypeCode create_abstract_interface_tc(String, String)ImplBase
class corresponding to the interface that is supported by the server. The servant must thus be a CORBA object reference and inherit fromorg.omg.CORBA.Object
. Servants created by the user can start receiving remote invocations after the methodconnect
has been called. A servant may also be automatically and implicitly connected to the ORB if it is passed as an IDL parameter in an IDL method invocation on a non-local object that is if the servant object has to be marshalled and sent outside of the process address space.Calling the method
connect
has no effect when the servant object is already connected to the ORB.Deprecated by the OMG in favor of the Portable Object Adapter APIs. @param obj the servant object reference @see
CORBA
package comments for unimplemented features
Create aClass ORB, DynAny create_basic_dyn_any(TypeCode)TypeCode
object for an IDL abstract interface. @param id the logical id for the abstract interface type. @param name the name of the abstract interface type. @return the requested TypeCode. @seeCORBA
package comments for unimplemented features
See package comments regarding unimplemented features. @see CORBA
package comments for unimplemented features
Class ORB, DynAny create_dyn_any(Any)See package comments regarding unimplemented features. @see CORBA
package comments for unimplemented features
Class ORB, DynArray create_dyn_array(TypeCode)See package comments regarding unimplemented features. @see CORBA
package comments for unimplemented features
Class ORB, DynEnum create_dyn_enum(TypeCode)See package comments regarding unimplemented features. @see CORBA
package comments for unimplemented features
Class ORB, DynSequence create_dyn_sequence(TypeCode)See package comments regarding unimplemented features. @see CORBA
package comments for unimplemented features
Class ORB, DynStruct create_dyn_struct(TypeCode)See package comments regarding unimplemented features. @see CORBA
package comments for unimplemented features
Class ORB, DynUnion create_dyn_union(TypeCode)See package comments regarding unimplemented features. @see CORBA
package comments for unimplemented features
Class ORB, TypeCode create_fixed_tc(short, short)Create aClass ORB, TypeCode create_native_tc(String, String)TypeCode
object for an IDL fixed type. @param digits specifies the total number of decimal digits in the number and must be from 1 to 31 inclusive. @param scale specifies the position of the decimal point. @return the requested TypeCode. @seeCORBA
package comments for unimplemented features
Create aClass ORB, Policy create_policy(int, Any)TypeCode
object for an IDL native type. @param id the logical id for the native type. @param name the name of the native type. @return the requested TypeCode. @seeCORBA
package comments for unimplemented features
See package comments regarding unimplemented features. @see CORBA
package comments for unimplemented features
Class ORB, TypeCode create_recursive_tc(String)Create a recursiveClass ORB, TypeCode create_string_tc(int)TypeCode
object which serves as a placeholder for a concrete TypeCode during the process of creating TypeCodes which contain recursion. The id parameter specifies the repository id of the type for which the recursive TypeCode is serving as a placeholder. Once the recursive TypeCode has been properly embedded in the enclosing TypeCode which corresponds to the specified repository id it will function as a normal TypeCode. Invoking operations on the recursive TypeCode before it has been embedded in the enclosing TypeCode will result in undefined behavior.For example the following IDL type declarations contain recursion:
Struct Foo { long value; Sequence <Foo> Chain; }; Struct Bar { public Bar member; };To create a TypeCode for struct Bar you would invoke the TypeCode creation operations as shown below:
String barID = "IDL:Bar:1.0"; TypeCode recursiveTC = orb.create_recursive_tc(barID); StructMember[] members = { new StructMember("member" recursiveTC null) }; TypeCode structBarTC = orb.create_struct_tc(barID "Bar" members);@param id the logical id of the referenced type.@return the requested TypeCode.@seeCORBA
package comments for unimplemented features
Creates aClass ORB, TypeCode create_value_box_tc(String, String, TypeCode)TypeCode
object representing a bounded IDLstring
. TheTypeCode
object is initialized with the given bound which represents the maximum length of the string. Zero indicates that the string described by this type code is unbounded. @param bound the bound for thestring
; cannot bezeronegative @return a newly-createdTypeCode
object describing a bounded IDLstring
@exception BAD_PARAM ifzerobound issupplied asaparameternegative value
Class ORB, TypeCode create_value_tc(String, String, short, TypeCode, ValueMember[])CreateCreates aTypeCode
object for an IDL valuetypebox.The concrete_base parameter is the TypeCode@paramforid theimmediate concrete valuetype base of thelogicalvaluetypeid forwhich the TypeCode is being created. It may be null ifthevaluetype does not have a concretevaluebase.type @paramidname thelogical idnameforof the value type.@paramnameboxed_type thename ofTypeCode for thevaluetype.@return the requested TypeCode.@seeCORBA
package comments for unimplemented features
Create aClass ORB, TypeCode create_wstring_tc(int)TypeCode
object for an IDL value type. The concrete_base parameter is the TypeCode for the immediate concrete valuetype base of the valuetype for which the TypeCode is being created. It may be null if the valuetype does not have a concrete base. @param id the logical id for the value type. @param name the name of the value type. @param type_modifier one of the value type modifier constants: VM_NONE VM_CUSTOM VM_ABSTRACT or VM_TRUNCATABLE @param concrete_base aTypeCode
object describing the concrete valuetype base @param members an array containing the members of the value type @return the requested TypeCode.@seeCORBA
package comments for unimplemented features
Creates aClass ORB, void disconnect(Object)TypeCode
object representing a bounded IDLwstring
(wide string). TheTypeCode
object is initialized with the given bound which represents the maximum length of the wide string. Zero indicates that the string described by this type code is unbounded. @param bound the bound for thewstring
; cannot bezeronegative @return a newly-createdTypeCode
object describing a bounded IDLwstring
@exception BAD_PARAM ifzerobound issupplied asaparameternegative value
Disconnects the given servant object from the ORB. After this method returns the ORB will reject incoming remote requests for the disconnected servant and will send the exceptionClass ORB, Current get_current()org.omg.CORBA.OBJECT_NOT_EXIST
back to the remote client. Thus the object appears to be destroyed from the point of view of remote clients. Note however that local requests issued using the servant directly do not pass through the ORB; hence they will continue to be processed by the servant.Calling the method
disconnect
has no effect if the servant is not connected to the ORB.Deprecated by the OMG in favor of the Portable Object Adapter APIs. @param obj The servant object to be disconnected from the ORB @see
CORBA
package comments for unimplemented features
Retrieves aClass ORB, boolean get_service_information(short, ServiceInformationHolder)Current
object. TheCurrent
interface is used to manage thread-specific information for use by services such as transactions and security. @seeCORBA
package comments for unimplemented features @return a newly-createdCurrent
object @deprecated use resolve_initial_references. @seeCORBA
package comments for unimplemented features
See package comments regarding unimplemented features. @see CORBA
package comments for unimplemented features
Class ORB, Object resolve_initial_references(String)Resolves a specific object reference from the set of available initial service names. @param object_name the name of the initial service as a string @return the object reference associated with the given name @exception InvalidName if the given name is not associated with a known serviceClass ORB, void shutdown(boolean)
Instructs the ORB to shut down which causes all object adapters to shut down. If theClass ORB, boolean work_pending()wait_for_completion
parameter is true this operation blocks until all ORB processing (including processing of currently executing requests object deactivation and other object adapter operations) has completed. TheORB.run
method will return aftershutdown
has been called. @param wait_for_completiontrue
to indicate that the ORB should complete processing before shutting down;false
to indicate that the ORB should shut down immediately @seeCORBA
package comments for unimplemented features
Returnstrue
if the ORB needs the main thread to perform some work andfalse
if the ORB does not need the main thread. @returntrue
if there is work pending meaning that the ORB needs the main thread to perform some work;false
if there is no work pending and thus the ORB does not need the main thread @seeCORBA
package comments for unimplemented features
Retrieves theDomainManagers
of this object. This allows administration services (and applications) to retrieve the domain managers and hence the security and other policies applicable to individual objects that are members of the domain. @returnThethe list of immediately enclosing domain managers of this object. At least one domain manager is always returned in the list since by default each object is associated with at least one domain manager at creation.
Theorg/omg/CORBA/Policyinterface provides a mechanism for ORBs and Object Services.javato allow accessGenerated by the IDL-tocertain choices-Javathatcompileraffect(portable)theirversionoperation"3.This information is accessed in a0"structuredfrommanner../../../../../src/share/classes/org/omg/PortableServer/corba.idlusing interfaces derived fromSaturday July 17 1999the12:26:20org.omg.CORBA.PolicyAMinterface.PDT
Converts the givenClass SetOverrideType, SetOverrideType ADD_OVERRIDEint
to the correspondingSetOverrideType
instance. @param i theint
to convert. It must be one of theint
constants in the classSetOverrideType
. @return theSetOverrideType
instance whose value matches the givenint
@exception BAD_PARAM if the givenint
does not match the value of anySetOverrideType
instance
The SetOverrideType
constant for the enum value ADD_OVERRIDE.
Class SetOverrideType, SetOverrideType SET_OVERRIDEThe SetOverrideType
constant for the enum value SET_OVERRIDE.
A container for information about a specific CORBA data type.Class TypeCode, TypeCode concrete_base_type()
TypeCode
objects are used:
- in the Dynamic Invocation Interface -- to indicate the types of the actual arguments or the type of the return value.
NamedValue
objects are used to represent arguments and return values. One of their components is anAny
object which in turn has as one of its components aTypeCode
object.- by an Interface Repository to represent the type specifications that are part of many OMG IDL declarations
The representation of a
TypeCode
object is opaque but abstractly aTypeCode
object consists of:
- a
kind
field which is set to an instance of the classTCKind
- zero or more additional fields appropriate for the particular kind. For example the
TypeCode
object describing the OMG IDL type1ong
has kindTCKind.tk_long
and no additional fields. TheTypeCode
describing OMG IDL typesequence<boolean 10>
has akind
field with the valueTCKind.tk_sequence
and also fields with the valuesboolean
and10
for the type of sequence elements and the length of the sequence.
TypeCode
objects can be obtained in various ways:
- from a call to the method
Any.insert_X
where X is a basic IDL type. This method creates aTypeCode
object for type X and assigns it to theAny
object'stype
field.- from invocations of methods in the ORB class
For example the following creates a
TypeCode
object for astring
with a maximum of 30 characters:org.omg.CORBA.TypeCode tcString = orb.create_string_tc(30);The following creates a
TypeCode
object for anarray
of fivestring
s:org.omg.CORBA.TypeCode tcArray = orb.create_array_tc( 5 TCKind.tk_string);The following creates a
TypeCode
object for an interface named "Account":org.omg.CORBA.TypeCode tcInterface = orb.create_interface_tc( "thisId" "Account");- as the return value from the
_type
method inHolder
classes for user-defined IDL types. TheseHolder
classes are generated by theidltojava
compiler.- from a CORBA Interface Repository
Most of the methods in the class
TypeCode
are accessors and the information contained in aTypeCode
object is specific to a particular type. Therefore methods must be invoked only on the kind of type codes to which they apply. If an accessor method tries to access information from an inappropriate kind of type code it will throw the exceptionTypeCodePackage.BadKind
. For example if the methoddiscriminator_type
is called on anything other than aunion
it will throwBadKind
because onlyunion
s have a discriminator. The following list shows which methods apply to which kinds of type codes:These methods may be invoked on all
TypeCode
kinds:
equal
kind
These methods may be invoked on
objref
struct
union
enum
alias
exception
value
value_box
native
andabstract_interface
:
id
name
These methods may be invoked on
struct
union
enum
andexception
:
member_count
member_name
These methods may be invoked on
struct
union
andexception
:
member_type(int index)
These methods may be invoked on
union
:
member_label
discriminator_type
default_index
These methods may be invoked on
string
sequence
andarray
:
length
These methods may be invoked on
alias
sequence
array
andvalue_box
:
content_type
Unlike other CORBA pseudo-objects
TypeCode
objects can be passed as general IDL parameters.The methods
parameter
andparam_count
which are deprecated are not mapped.Java IDL extends the CORBA specification to allow all operations permitted on a
struct
TypeCode
to be permitted on anexception
TypeCode
as well.@version 1.25 09/09/97
Returns theClass TypeCode, TypeCode content_type()TypeCode
object that describes the concrete base type of the value type that thisTypeCode
object describes. Returns null if it doesn't have a concrete base type. @return theTypeCode
object that describes the concrete base type of the value type that thisTypeCode
object describes @exceptionthrows org.omg.CORBA.TypeCodePackage.BadKind if this method is invoked on a non-boxed value typeTypeCode
object @seeCORBA
package comments for unimplemented features
Returns theClass TypeCode, int default_index()TypeCode
object representing the IDL type for the members of the object described by thisTypeCode
object. For sequences and arrays it returns the element type. For aliases it returns the original type. Note that multidimensional arrays are represented by nestingTypeCode
objects one per dimension. For boxed valuetypes it returns the boxed type.The method
content_type
can be invoked on sequence array alias and boxed valuetypeTypeCode
objects. @return aTypeCode
object representing the element type for sequences and arrays the original type for aliases or the boxed type for boxed valuetypes. @exceptionthrows org.omg.CORBA.TypeCodePackage.BadKind if the method is invoked on an inappropriate kind ofTypeCode
object
Returns the index of the default member or -1 if there is no default member.Class TypeCode, TypeCode discriminator_type()The method
default_index
can be invoked only on unionTypeCode
objects. @return the index of the default member or -1 if there is no default member @exceptionthrows org.omg.CORBA.TypeCodePackage.BadKind if the method is invoked on a non-unionTypeCode
object
Returns aClass TypeCode, boolean equivalent(TypeCode)TypeCode
object describing all non-default member labels. The methoddiscriminator_type
can be invoked only on unionTypeCode
objects. @return theTypeCode
object describing the non-default member labels @exceptionthrows org.omg.CORBA.TypeCodePackage.BadKind if the method is invoked on a non-unionTypeCode
object
Tests to see if the givenClass TypeCode, short fixed_digits()TypeCode
object is equivalent to thisTypeCode
object.Not implemented; see package comments. @param tc the typecode to compare with this typecode @return
@seetrue
if the given typecode is equivalent to this typecode;false
otherwiseCORBA
package comments for unimplemented features
Returns the number of digits in the fixed type described by thisClass TypeCode, short fixed_scale()TypeCode
object. For example the typecode for the number 3000.275d could befixed< 3>
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 ofTypeCode
object @seeCORBA
package comments for unimplemented features
Returns the scale of the fixed type described by thisClass TypeCode, TypeCode get_compact_typecode()TypeCode
object. A positive number indicates the number of digits to the right of the decimal point. For example the number 3000d could have the typecodefixed< 0>
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 casefixed< -3>
could be the typecode for the number 3000d. @return the scale of the fixed type that thisTypeCode
object describes @throws org.omg.CORBA.TypeCodePackage.BadKind if this method is invoked on an inappropriate kind ofTypeCode
object @seeCORBA
package comments for unimplemented features
Strips out all optional nameClass TypeCode, String id()&and member name fields butitleaves all alias typecodes intact. @return aTypeCode
object with optional name and member name fields stripped out except for alias typecodes which are left intact @seeCORBA
package comments for unimplemented features
Retrieves the RepositoryId globally identifying the type of thisClass TypeCode, int length()TypeCode
object.The method
id
can be invoked on object reference structure union enumeration alias exception valuetype boxed valuetype native and abstract interface type codes. Object reference exception valuetype boxed valuetype native and abstract interfaceTypeCode
objects always have a RepositoryId. Structure union enumeration and aliasTypeCode
objects obtained from the Interface Repository or the methodORB.create_operation_list
also always have a RepositoryId. If there is no RepositoryId the method can return an empty string. @return the RepositoryId for thisTypeCode
object or an empty string if there is no RepositoryID @exceptionthrows org.omg.CORBA.TypeCodePackage.BadKind if the method is invoked on an inappropriate kind ofTypeCode
object
Returns the number of elements in the type described by thisClass TypeCode, int member_count()TypeCode
object. For strings and sequences it returns the bound with zero indicating an unbounded string or sequence. For arrays it returns the number of elements in the array.The method
length
can be invoked on string sequence and arrayTypeCode
objects. @return the bound for strings and sequences or the number of elements for arrays @exceptionthrows org.omg.CORBA.TypeCodePackage.BadKind if the method is invoked on an inappropriate kind ofTypeCode
object
Retrieves the number of members in the type described by thisClass TypeCode, Any member_label(int)TypeCode
object.The method
member_count
can be invoked on structure union and enumerationTypeCode
objects. Java IDL extends the CORBA specification to allow this method to operate on exceptions as well. @return the number of members constituting the type described by thisTypeCode
object @exceptionthrows org.omg.CORBA.TypeCodePackage.BadKind if the method is invoked on an inappropriate kind ofTypeCode
object
Retrieves the label of the union member identified by the given index. For the default member the label is the zero octet.Class TypeCode, String member_name(int)The method
member_label
can only be invoked on unionTypeCode
objects. @param index index of the union member for which the label is being requested @return anAny
object describing the label of the requested union member or the zero octet for the default member @exceptionthrows org.omg.CORBA.TypeCodePackage.Bounds if the index is equal to or greater than the number of members constituting the union @exceptionthrows org.omg.CORBA.TypeCodePackage.BadKind if the method is invoked on a non-unionTypeCode
object
Retrieves the simple name of the member identified by the given index. Since names are local to a Repository the name returned from aClass TypeCode, TypeCode member_type(int)TypeCode
object may not match the name of the member in any particular Repository and may even be an empty string.The method
member_name
can be invoked on structure union and enumerationTypeCode
objects. Java IDL extends the CORBA specification to allow this method to operate on exceptions as well. @param index index of the member for which a name is being reqested @return simple name of the member identified by the index or an empty string @exceptionthrows org.omg.CORBA.TypeCodePackage.Bounds if the index is equal to or greater than the number of members constituting the type @exceptionthrows org.omg.CORBA.TypeCodePackage.BadKind if the method is invoked on an inappropriate kind ofTypeCode
object
Retrieves theClass TypeCode, short member_visibility(int)TypeCode
object describing the type of the member identified by the given index.The method
member_type
can be invoked on structure and unionTypeCode
objects. Java IDL extends the CORBA specification to allow this method to operate on exceptions as well. @param index index of the member for which type information is begin requested @return theTypeCode
object describing the member at the given index @exceptionthrows org.omg.CORBA.TypeCodePackage.Bounds if the index is equal to or greater than the number of members constituting the type @exceptionthrows org.omg.CORBA.TypeCodePackage.BadKind if the method is invoked on an inappropriate kind ofTypeCode
object
Returns the constant that indicates the visibility of the member at the given index. This operation can only be invoked on non-boxed valueClass TypeCode, String name()TypeCode
objects. @param index anint
indicating the index into the value @return eitherPRIVATE_MEMBER.value
orPUBLIC_MEMBER.value
@exceptionthrows org.omg.CORBA.TypeCodePackage.BadKind if this method is invoked on a non-value typeTypeCode
object @exceptionthrows org.omg.CORBA.TypeCodePackage.Bounds if the given index is out of bounds @seeCORBA
package comments for unimplemented features
Retrieves the simple name identifying thisClass TypeCode, short type_modifier()TypeCode
object within its enclosing scope. Since names are local to a Repository the name returned from aTypeCode
object may not match the name of the type in any particular Repository and may even be an empty string.The method
name
can be invoked on object reference structure union enumeration alias exception valuetype boxed valuetype native and abstract interfaceTypeCode
objects. @return the name identifying thisTypeCode
object or an empty string @exceptionthrows org.omg.CORBA.TypeCodePackage.BadKind if the method is invoked on an inappropriate kind ofTypeCode
object
Returns a constant indicating the modifier of the value type that thisTypeCode
object describes. The constant returned must be one of the following:VM_NONE.value
VM_ABSTRACT.value
VM_CUSTOM.value
orVM_TRUNCATABLE.value
@return a constant describing the value type that thisTypeCode
object describes @exceptionthrows org.omg.CORBA.TypeCodePackage.BadKind if this method is invoked on a non-value typeTypeCode
object @seeCORBA
package comments for unimplemented features