|
Generated by JDiff |
||||||||
| PREV PACKAGE NEXT PACKAGE FRAMES NO FRAMES | |||||||||
This file contains all the changes in documentation in the packageorg.omg.CORBAas 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.valueis 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)Anyobject is used as a component of aNamedValueobject which provides information about arguments or return values in requests and which is used to define name/value pairs inContextobjects.An
Anyobject consists of two parts:
- a data value
- a
TypeCodeobject describing the type of the data value contained in theAnyobject. For example aTypeCodeobject 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 theTypeCodeobject is itself aTypeCodeobject.)
Checks for equality between thisClass Any, Object extract_Object()Anyobject and the givenAnyobject. TwoAnyobjects are equal if both their values and type codes are equal. @param a theAnyobject to test for equality @returntrueif theAnyobjects are equal;falseotherwise @seeCORBApackage comments for unimplemented features
Extracts theClass Any, Principal extract_Principal()org.omg.CORBA.Objectin thisAnyobject'svaluefield. @return theorg.omg.CORBA.Objectstored in thisAnyobject @exception BAD_OPERATION if thisAnyobject contains something other than anorg.omg.CORBA.Objector thevaluefield has not yet been set
Extracts theClass Any, TypeCode extract_TypeCode()Principalobject in thisAnyobject'svaluefield. Note that the classPrincipalhas been deprecated. @return thePrincipalobject stored in thisAnyobject @exception BAD_OPERATION if thisAnyobject contains something other than aPrincipalobject or thevaluefield has not yet been set @deprecated Deprecated by CORBA 2.2.
Extracts theClass Any, Serializable extract_Value()TypeCodeobject in thisAnyobject'svaluefield. @return theTypeCodeobject stored in thisAnyobject @exception BAD_OPERATION if thisAnyobject contains something other than aTypeCodeobject or thevaluefield has not yet been set
Extracts theClass Any, Any extract_any()java.io.Serializableobject in thisAnyobject'svaluefield. @return thejava.io.Serializableobject stored in thisAnyobject @exception BAD_OPERATION if thisAnyobject contains something other than ajava.io.Serializableobject or thevaluefield has not yet been set
Extracts theClass Any, boolean extract_boolean()Anyobject in thisAnyobject'svaluefield. @return theAnyobject stored in thisAnyobject @exception BAD_OPERATION if thisAnyobject contains something other than anAnyobject or thevaluefield has not yet been set
Extracts theClass Any, char extract_char()booleanin thisAnyobject'svaluefield. @return thebooleanstored in thisAnyobject @exception BAD_OPERATION if thisAnyobject contains something other than abooleanor thevaluefield has not yet been set
Extracts theClass Any, double extract_double()charin thisAnyobject'svaluefield. @return thecharstored in thisAnyobject @exception BAD_OPERATION if thisAnyobject contains something other than acharor thevaluefield has not yet been set
Extracts theClass Any, BigDecimal extract_fixed()doublein thisAnyobject'svaluefield. @return thedoublestored in thisAnyobject @exception BAD_OPERATION if thisAnyobject contains something other than adoubleor thevaluefield has not yet been set
Extracts theClass Any, float extract_float()java.math.BigDecimalobject in thisAnyobject'svaluefield. @return thejava.math.BigDecimalobject stored in thisAnyobject @exception BAD_OPERATION if thisAnyobject contains something other than ajava.math.BigDecimalobject or thevaluefield has not yet been set
Extracts theClass Any, int extract_long()floatin thisAnyobject'svaluefield. @return thefloatstored in thisAnyobject @exception BAD_OPERATION if thisAnyobject contains something other than afloator thevaluefield has not yet been set
Extracts theClass Any, long extract_longlong()intin thisAnyobject'svaluefield. @return theintstored in thisAnyobject @exception BAD_OPERATION if thisAnyobject contains something other than anintor thevaluefield has not yet been set
Extracts theClass Any, byte extract_octet()longin thisAnyobject'svaluefield. @return thelongstored in thisAnyobject @exception BAD_OPERATION if thisAnyobject contains something other than alongor thevaluefield has not yet been set
Extracts theClass Any, short extract_short()bytein thisAnyobject'svaluefield. @return thebytestored in thisAnyobject @exception BAD_OPERATION if thisAnyobject contains something other than abyteor thevaluefield has not yet been set
Extracts theClass Any, String extract_string()shortin thisAnyobject'svaluefield. @return theshortstored in thisAnyobject @exception BAD_OPERATION if thisAnyobject contains something other than ashortor thevaluefield has not yet been set
Extracts theClass Any, int extract_ulong()Stringobject in thisAnyobject'svaluefield. @return theStringobject stored in thisAnyobject @exception BAD_OPERATION if thisAnyobject contains something other than aStringobject or thevaluefield has not yet been set
Extracts theClass Any, long extract_ulonglong()intin thisAnyobject'svaluefield. @return theintstored in thisAnyobject @exception BAD_OPERATION if thisAnyobject contains something other than anintor thevaluefield has not yet been set
Extracts theClass Any, short extract_ushort()longin thisAnyobject'svaluefield. @return thelongstored in thisAnyobject @exception BAD_OPERATION if thisAnyobject contains something other than alongor thevaluefield has not yet been set
Extracts theClass Any, char extract_wchar()shortin thisAnyobject'svaluefield. @return theshortstored in thisAnyobject @exception BAD_OPERATION if thisAnyobject contains something other than ashortor thevaluefield has not yet been set
Extracts theClass Any, String extract_wstring()charin thisAnyobject'svaluefield. @return thecharstored in thisAnyobject @exception BAD_OPERATION if thisAnyobject contains something other than acharor thevaluefield has not yet been set
Extracts theClass Any, void insert_Object(Object, TypeCode)Stringobject in thisAnyobject'svaluefield. @return theStringobject stored in thisAnyobject @exception BAD_OPERATION if thisAnyobject contains something other than aStringobject or thevaluefield has not yet been set
Inserts the givenClass Any, void insert_Value(Serializable, TypeCode)org.omg.CORBA.Objectobject into thisAnyobject'svaluefield. @param o theorg.omg.CORBA.Objectinstance to insert into thisAnyobject @param t theTypeCodeobject that is to be inserted into thisAnyobject and that describes theObjectbeing inserted @exception BAD_OPERATION if this method is invalid for thisAnyobject
Inserts the givenClass Any, void insert_char(char)java.io.Serializableobject into thisAnyobject'svaluefield. @param v thejava.io.Serializableobject to insert into thisAnyobject @param t theTypeCodeobject that is to be inserted into thisAnyobject'stypefield and that describes thejava.io.Serializableobject being inserted @throws MARSHAL if the ORB has a problem marshalling or unmarshalling parameters
Inserts the givenClass Any, void insert_string(String)charinto thisAnyobject'svaluefield. @param c thecharto insert into thisAnyobject @exception DATA_CONVERSION if there is a data conversion error
Inserts the givenClass Any, void insert_wstring(String)Stringobject into thisAnyobject'svaluefield. @param s theStringobject to insert into thisAnyobject @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()Stringobject into thisAnyobject'svaluefield. @param s theStringobject to insert into thisAnyobject @exception MARSHAL if the ORB has a problem marshalling or unmarshalling parameters
Returns type information for the element contained in thisAnyobject. @return theTypeCodeobject containing type information about the value contained in thisAnyobject.
Creates aCompletionStatusobject from the givenint. @param i one of_COMPLETED_YES_COMPLETED_NOor_COMPLETED_MAYBE@return one of the possibleCompletionStatusobjects with values:_COMPLETED_YES_COMPLETED_NOor_COMPLETED_MAYBE@exception org.omg.CORBA.BAD_PARAM if the argument given is not one of theintconstants defined inCompletionStatus
Retrieves theClass Context, void set_values(NVList)NamedValueobjects whosenamefield 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 allContextobjects 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
Stringobject 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_scopeor thisContextobject. @param pattern the property name whose values are to be retrieved.patternmay be a name or a name with a trailing wildcard character ("*"). @return anNVListcontaining all the property values (in the form ofNamedValueobjects) whose associated property name matches the given name or name pattern @see org.omg.CORBA.NamedValue
I Sets one or more property values in thisContextobject. TheNVListsupplied to this method contains one or moreNamedValueobjects. In eachNamedValueobject thenamefield holds the name of the property and theflagsfield must be set to zero. TheNamedValueobject'svaluefield contains anAnyobject which in turn contains the value for the property. Since the value is always a string theAnyobject must have thekindfield of itsTypeCodeset 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 anintand those that are an instance of the classDefinitionKind. This class provides the methodfrom_intwhich given one of theintconstants creates the correspondingDefinitionKindinstance. It also provides the methodvaluewhich returns theintconstant that is the value for aDefinitionKindinstance. @see IRObject
Class DefinitionKind, int value()Returns theCreates aDefinitionKindinstance corresponding to the given code . @param i one of theintconstants from the classDefinitionKind@return theDefinitionKindinstance corresponding to the given code @throws org.omg.CORBA.BAD_PARAM if the given parameter is not one ofatheintconstants from the classDefinitionKind.
Returns theClass DefinitionKind, DefinitionKind dk_allcodeintconstant identifying the type of an IR object. @return thecodeintconstant from the classDefinitionKindthat is the value of thisDefinitionKindinstance.
The wildcarddefinitionDefinitionKindkindconstant useful in all occasions where anyDefinitionKindis appropriate. TheContainersContainer'scontentsmethod 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 theDynAnyobject whosevalue willcontentsbe usedare assigned toinitializethisDynAnyobject. @exceptionthrowsorg.omg.CORBA.DynAnyPackage.Invalid if thegivensourceDynAnyobject has a type code thatisnot equivalent or has not been assigned a valueinvalid
Class DynAny, DynAny current_component()CloneClones thisDnyAnyDynAnyobject. @returnthea copy of thisDynAny.object
Returns aClass DynAny, void from_any(Any)DynAnyobject reference that can be used to get/set the value of the component currently accessed. The appropriateorinsertmethod can be called on the resultingDynAnyobject to initialize the component. The appropriategetmethod can be called on the resultingDynAnyobject to extract the value of the component. @return aDynAnyobject 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 thisaDynAnyobjectwith the value associated withfromthe givenanAnyobject. @param value theAnyobjectwhose value will be used to initialize this DynAny object. @exceptionthrowsorg.omg.CORBA.DynAnyPackage.Invalid if thegivensourceAnyobjecthas a type code thatisnot equivalentempty orhas not been assigned a valuebad
Retrieves theClass DynAny, boolean get_boolean()org.omg.CORBA.Anycontained in thisDynAnyobject. @return theorg.omg.CORBA.Anythat is the value for thisDynAnyobject @exceptionthrows org.omg.CORBA.DynAnyPackage.TypeMismatch if the type code of the accessed component in thisDynAnyobject is not equivalent to the type code foraanorg.omg.CORBA.Any
Retrieves theClass DynAny, char get_char()booleancontained in thisDynAnyobject. @return thebooleanthat is the value for thisDynAnyobject @exceptionthrows org.omg.CORBA.DynAnyPackage.TypeMismatch if the type code of the accessed component in thisDynAnyobject is not equivalent to the type code for aboolean
Retrieves theClass DynAny, double get_double()charcontained in thisDynAnyobject. @return thecharthat is the value for thisDynAnyobject @exceptionthrows org.omg.CORBA.DynAnyPackage.TypeMismatch if the type code of the accessed component in thisDynAnyobject is not equivalent to the type code for achar
Retrieves theClass DynAny, float get_float()doublecontained in thisDynAnyobject. @return thedoublethat is the value for thisDynAnyobject @exceptionthrows org.omg.CORBA.DynAnyPackage.TypeMismatch if the type code of the accessed component in thisDynAnyobject is not equivalent to the type code for adouble
Retrieves theClass DynAny, int get_long()floatcontained in thisDynAnyobject. @return thefloatthat is the value for thisDynAnyobject @exceptionthrows org.omg.CORBA.DynAnyPackage.TypeMismatch if the type code of the accessed component in thisDynAnyobject is not equivalent to the type code for afloat
Retrieves theClass DynAny, long get_longlong()intcontained in thisDynAnyobject. @return theintthat is the value for thisDynAnyobject @exceptionthrows org.omg.CORBA.DynAnyPackage.TypeMismatch if the type code of the accessed component in thisDynAnyobject is not equivalent to the type code for aint
Retrieves theClass DynAny, byte get_octet()longcontained in thisDynAnyobject. @return thelongthat is the value for thisDynAnyobject @exceptionthrows org.omg.CORBA.DynAnyPackage.TypeMismatch if the type code of the accessed component in thisDynAnyobject is not equivalent to the type code for along
Retrieves theClass DynAny, Object get_reference()bytecontained in thisDynAnyobject. @return thebytethat is the value for thisDynAnyobject @exceptionthrows org.omg.CORBA.DynAnyPackage.TypeMismatch if the type code of the accessed component in thisDynAnyobject is not equivalent to the type code for abyte
Retrieves theClass DynAny, short get_short()org.omg.CORBA.Othercontained in thisDynAnyobject. @return theorg.omg.CORBA.Otherthat is the value for thisDynAnyobject @exceptionthrows org.omg.CORBA.DynAnyPackage.TypeMismatch if the type code of the accessed component in thisDynAnyobject is not equivalent to the type code for anorg.omg.CORBA.Other
Retrieves theClass DynAny, String get_string()shortcontained in thisDynAnyobject. @return theshortthat is the value for thisDynAnyobject @exceptionthrows org.omg.CORBA.DynAnyPackage.TypeMismatch if the type code of the accessed component in thisDynAnyobject is not equivalent to the type code for ashort
Retrieves theClass DynAny, TypeCode get_typecode()Stringcontained in thisDynAnyobject. @return theStringthat is the value for thisDynAnyobject @exceptionthrows org.omg.CORBA.DynAnyPackage.TypeMismatch if the type code of the accessed component in thisDynAnyobject is not equivalent to the type code for aString
Retrieves theClass DynAny, int get_ulong()org.omg.CORBA.TypeCodecontained in thisDynAnyobject. @return theorg.omg.CORBA.TypeCodethat is the value for thisDynAnyobject @exceptionthrows org.omg.CORBA.DynAnyPackage.TypeMismatch if the type code of the accessed component in thisDynAnyobject is not equivalent to the type code for aorg.omg.CORBA.TypeCode
Retrieves theClass DynAny, long get_ulonglong()intcontained in thisDynAnyobject. @return theintthat is the value for thisDynAnyobject @exceptionthrows org.omg.CORBA.DynAnyPackage.TypeMismatch if the type code of the accessed component in thisDynAnyobject is not equivalent to the type code for aint
Retrieves theClass DynAny, short get_ushort()longcontained in thisDynAnyobject. @return thelongthat is the value for thisDynAnyobject @exceptionthrows org.omg.CORBA.DynAnyPackage.TypeMismatch if the type code of the accessed component in thisDynAnyobject is not equivalent to the type code for along
Retrieves theClass DynAny, Serializable get_val()shortcontained in thisDynAnyobject. @return theshortthat is the value for thisDynAnyobject @exceptionthrows org.omg.CORBA.DynAnyPackage.TypeMismatch if the type code of the accessed component in thisDynAnyobject is not equivalent to the type code for ashort
Retrieves theClass DynAny, char get_wchar()java.io.Serializableobject contained in thisDynAnyobject. @return thejava.io.Serializableobject that is the value for thisDynAnyobject @exceptionthrows org.omg.CORBA.DynAnyPackage.TypeMismatch if the type code of the accessed component in thisDynAnyobject is not equivalent to the type code for ajava.io.Serializableobject
Retrieves theClass DynAny, String get_wstring()charcontained in thisDynAnyobject. @return thecharthat is the value for thisDynAnyobject @exceptionthrows org.omg.CORBA.DynAnyPackage.TypeMismatch if the type code of the accessed component in thisDynAnyobject is not equivalent to the type code for achar
Retrieves theClass DynAny, void insert_any(Any)Stringcontained in thisDynAnyobject. @return theStringthat is the value for thisDynAnyobject @exceptionthrows org.omg.CORBA.DynAnyPackage.TypeMismatch if the type code of the accessed component in thisDynAnyobject is not equivalent to the type code for aString
Inserts the givenClass DynAny, void insert_boolean(boolean)org.omg.CORBA.Anyobject as the value for thisDynAnyobject.If this method is called on a constructed
DynAnyobject it initializes the next component of the constructed data value associated with thisDynAnyobject. @param value theorg.omg.CORBA.Anyobject to insert into thisDynAnyobject @exceptionthrows org.omg.CORBA.DynAnyPackage.InvalidValue if the value inserted is not consistent with the type of the accessed component in thisDynAnyobject
Inserts the givenClass DynAny, void insert_char(char)booleanas the value for thisDynAnyobject.If this method is called on a constructed
DynAnyobject it initializes the next component of the constructed data value associated with thisDynAnyobject. @param value thebooleanto insert into thisDynAnyobject @exceptionthrows org.omg.CORBA.DynAnyPackage.InvalidValue if the value inserted is not consistent with the type of the accessed component in thisDynAnyobject
Inserts the givenClass DynAny, void insert_double(double)charas the value for thisDynAnyobject.If this method is called on a constructed
DynAnyobject it initializes the next component of the constructed data value associated with thisDynAnyobject. @param value thecharto insert into thisDynAnyobject @exceptionthrows org.omg.CORBA.DynAnyPackage.InvalidValue if the value inserted is not consistent with the type of the accessed component in thisDynAnyobject
Inserts the givenClass DynAny, void insert_float(float)doubleas the value for thisDynAnyobject.If this method is called on a constructed
DynAnyobject it initializes the next component of the constructed data value associated with thisDynAnyobject. @param value thedoubleto insert into thisDynAnyobject @exceptionthrows org.omg.CORBA.DynAnyPackage.InvalidValue if the value inserted is not consistent with the type of the accessed component in thisDynAnyobject
Inserts the givenClass DynAny, void insert_long(int)floatas the value for thisDynAnyobject.If this method is called on a constructed
DynAnyobject it initializes the next component of the constructed data value associated with thisDynAnyobject. @param value thefloatto insert into thisDynAnyobject @exceptionthrows org.omg.CORBA.DynAnyPackage.InvalidValue if the value inserted is not consistent with the type of the accessed component in thisDynAnyobject
Inserts the givenClass DynAny, void insert_longlong(long)intas the value for thisDynAnyobject.If this method is called on a constructed
DynAnyobject it initializes the next component of the constructed data value associated with thisDynAnyobject. @param value theintto insert into thisDynAnyobject @exceptionthrows org.omg.CORBA.DynAnyPackage.InvalidValue if the value inserted is not consistent with the type of the accessed component in thisDynAnyobject
Inserts the givenClass DynAny, void insert_octet(byte)longas the value for thisDynAnyobject.If this method is called on a constructed
DynAnyobject it initializes the next component of the constructed data value associated with thisDynAnyobject. @param value thelongto insert into thisDynAnyobject @exceptionthrows org.omg.CORBA.DynAnyPackage.InvalidValue if the value inserted is not consistent with the type of the accessed component in thisDynAnyobject
Inserts the givenClass DynAny, void insert_reference(Object)byteas the value for thisDynAnyobject.If this method is called on a constructed
DynAnyobject it initializes the next component of the constructed data value associated with thisDynAnyobject. @param value thebyteto insert into thisDynAnyobject @exceptionthrows org.omg.CORBA.DynAnyPackage.InvalidValue if the value inserted is not consistent with the type of the accessed component in thisDynAnyobject
Inserts the givenClass DynAny, void insert_short(short)org.omg.CORBA.Objectas the value for thisDynAnyobject.If this method is called on a constructed
DynAnyobject it initializes the next component of the constructed data value associated with thisDynAnyobject. @param value theorg.omg.CORBA.Objectto insert into thisDynAnyobject @exceptionthrows org.omg.CORBA.DynAnyPackage.InvalidValue if the value inserted is not consistent with the type of the accessed component in thisDynAnyobject
Inserts the givenClass DynAny, void insert_string(String)shortas the value for thisDynAnyobject.If this method is called on a constructed
DynAnyobject it initializes the next component of the constructed data value associated with thisDynAnyobject. @param value theshortto insert into thisDynAnyobject @exceptionthrows org.omg.CORBA.DynAnyPackage.InvalidValue if the value inserted is not consistent with the type of the accessed component in thisDynAnyobject
Inserts the givenClass DynAny, void insert_typecode(TypeCode)Stringobject as the value for thisDynAnyobject.If this method is called on a constructed
DynAnyobject it initializes the next component of the constructed data value associated with thisDynAnyobject. @param value theStringto insert into thisDynAnyobject @exceptionthrows org.omg.CORBA.DynAnyPackage.InvalidValue if the value inserted is not consistent with the type of the accessed component in thisDynAnyobject
Inserts the givenClass DynAny, void insert_ulong(int)org.omg.CORBA.TypeCodeas the value for thisDynAnyobject.If this method is called on a constructed
DynAnyobject it initializes the next component of the constructed data value associated with thisDynAnyobject. @param value theorg.omg.CORBA.TypeCodeto insert into thisDynAnyobject @exceptionthrows org.omg.CORBA.DynAnyPackage.InvalidValue if the value inserted is not consistent with the type of the accessed component in thisDynAnyobject
Inserts the givenClass DynAny, void insert_ulonglong(long)intas the value for thisDynAnyobject.If this method is called on a constructed
DynAnyobject it initializes the next component of the constructed data value associated with thisDynAnyobject. @param value theintto insert into thisDynAnyobject @exceptionthrows org.omg.CORBA.DynAnyPackage.InvalidValue if the value inserted is not consistent with the type of the accessed component in thisDynAnyobject
Inserts the givenClass DynAny, void insert_ushort(short)longas the value for thisDynAnyobject.If this method is called on a constructed
DynAnyobject it initializes the next component of the constructed data value associated with thisDynAnyobject. @param value thelongto insert into thisDynAnyobject @exceptionthrows org.omg.CORBA.DynAnyPackage.InvalidValue if the value inserted is not consistent with the type of the accessed component in thisDynAnyobject
Inserts the givenClass DynAny, void insert_val(Serializable)shortas the value for thisDynAnyobject.If this method is called on a constructed
DynAnyobject it initializes the next component of the constructed data value associated with thisDynAnyobject. @param value theshortto insert into thisDynAnyobject @exceptionthrows org.omg.CORBA.DynAnyPackage.InvalidValue if the value inserted is not consistent with the type of the accessed component in thisDynAnyobject
Inserts the givenClass DynAny, void insert_wchar(char)java.io.Serializableobject as the value for thisDynAnyobject.If this method is called on a constructed
DynAnyobject it initializes the next component of the constructed data value associated with thisDynAnyobject. @param value thejava.io.Serializableobject to insert into thisDynAnyobject @exceptionthrows org.omg.CORBA.DynAnyPackage.InvalidValue if the value inserted is not consistent with the type of the accessed component in thisDynAnyobject
Inserts the givenClass DynAny, void insert_wstring(String)charas the value for thisDynAnyobject.If this method is called on a constructed
DynAnyobject it initializes the next component of the constructed data value associated with thisDynAnyobject. @param value thecharto insert into thisDynAnyobject @exceptionthrows org.omg.CORBA.DynAnyPackage.InvalidValue if the value inserted is not consistent with the type of the accessed component in thisDynAnyobject
Inserts the givenClass DynAny, Any to_any()Stringas the value for thisDynAnyobject.If this method is called on a constructed
DynAnyobject it initializes the next component of the constructed data value associated with thisDynAnyobject. @param value theStringto insert into thisDynAnyobject @exceptionthrows org.omg.CORBA.DynAnyPackage.InvalidValue if the value inserted is not consistent with the type of the accessed component in thisDynAnyobject
Class DynAny, TypeCode type()CreatesConvertan Any object from this DynAny object. The type code and value of thisaDynAnyobjectare copied into thetonewly-createdanAnyobject. @return thenewly-createdAnyobject. @exceptionthrowsorg.omg.CORBA.DynAnyPackage.Invalid if thisDynAnyobject hasisnot beenempty orcorrectlybad. created or does not contain a meaningful value
RetrievesReturns theTypeCodeobject 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 ofintothethisDynAnyobject. @return theTypeCodeobjectdescribing the value contained in this DynAny object.
Class DynArray, void set_elements(Any[])ReturnReturns the value of all the elements ofthethis array. @returnanthe array ofAnys.objects that is the value for thisDynArrayobject @see #set_elements
SetSets thevaluesvalue ofall elements ofthisanDynArrayarray represented by thisobject to the givenDynArrayarray. @param value the array ofAnys.objects @exception InvalidSeq if the sequence is bad.@see #get_elements
Class DynFixed, byte[] get_value()TheRepresentsDynFixed interface representsaDynAnyobjectwhichthat is associated with an IDL fixed type.
Class DynFixed, void set_value(byte[])ReturnReturns the value of the fixed type represented inthethisDynFixedobject. @return the value as a byte array @see #set_value
SetSets thevalue of thegiven fixed type instanceintoas the value for thisDynFixedobject. @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 ofrepresentsaDynAnyobjectwhichthat is associated with an IDL sequence.
Class DynSequence, int length()ReturnReturnsallthe value ofall elementsevery element in this sequence. @return an array ofAnys.objects containing the values in the sequence @see #set_elements
Class DynSequence, void length(int)ReturnReturns the length of the sequence representedinby thisDynFixedobject. @returnan integerthe length.of the sequence
Class DynSequence, void set_elements(Any[])SetSets the length of the sequence representedinby thisDynFixedobject 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 ofAnys.objects to be set @exception InvalidSeqis thrownif the array of values is bad.@see #get_elements
TheClass DynStruct, TCKind current_member_kind()DynStruct interfacerepresentation ofrepresentsaDynAnyobjectwhichthat is associated with an IDL struct.
Class DynStruct, String current_member_name()ReturnReturns theobject that describes the kind of the current member. @return theTypeCodeTCKindTCKindobject 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 theTypeCodeTCKindkindobject thatofdescribes the current member. @return theTCKindobject corresponding to the current member.
Class DynValue, NameValuePair[] get_members()ReturnReturns the name of the current member while traversing aDynAnywhichobject 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 thisDynValueobject represents to the given array ofNameValuePairobjects. @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)ImplBaseclass 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 methodconnecthas 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
connecthas 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
CORBApackage comments for unimplemented features
Create aClass ORB, DynAny create_basic_dyn_any(TypeCode)TypeCodeobject 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. @seeCORBApackage 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)TypeCodeobject 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. @seeCORBApackage comments for unimplemented features
Create aClass ORB, Policy create_policy(int, Any)TypeCodeobject 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. @seeCORBApackage 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)TypeCodeobject 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.@seeCORBApackage comments for unimplemented features
Creates aClass ORB, TypeCode create_value_box_tc(String, String, TypeCode)TypeCodeobject representing a bounded IDLstring. TheTypeCodeobject 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-createdTypeCodeobject describing a bounded IDLstring@exception BAD_PARAM ifzerobound issupplied asaparameternegative value
Class ORB, TypeCode create_value_tc(String, String, short, TypeCode, ValueMember[])CreateCreates aTypeCodeobject 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.@seeCORBApackage comments for unimplemented features
Create aClass ORB, TypeCode create_wstring_tc(int)TypeCodeobject 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 aTypeCodeobject describing the concrete valuetype base @param members an array containing the members of the value type @return the requested TypeCode.@seeCORBApackage comments for unimplemented features
Creates aClass ORB, void disconnect(Object)TypeCodeobject representing a bounded IDLwstring(wide string). TheTypeCodeobject 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-createdTypeCodeobject 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_EXISTback 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
disconnecthas 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
CORBApackage comments for unimplemented features
Retrieves aClass ORB, boolean get_service_information(short, ServiceInformationHolder)Currentobject. TheCurrentinterface is used to manage thread-specific information for use by services such as transactions and security. @seeCORBApackage comments for unimplemented features @return a newly-createdCurrentobject @deprecated use resolve_initial_references. @seeCORBApackage 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_completionparameter 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.runmethod will return aftershutdownhas been called. @param wait_for_completiontrueto indicate that the ORB should complete processing before shutting down;falseto indicate that the ORB should shut down immediately @seeCORBApackage comments for unimplemented features
Returnstrueif the ORB needs the main thread to perform some work andfalseif the ORB does not need the main thread. @returntrueif there is work pending meaning that the ORB needs the main thread to perform some work;falseif there is no work pending and thus the ORB does not need the main thread @seeCORBApackage comments for unimplemented features
Retrieves theDomainManagersof 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_OVERRIDEintto the correspondingSetOverrideTypeinstance. @param i theintto convert. It must be one of theintconstants in the classSetOverrideType. @return theSetOverrideTypeinstance whose value matches the givenint@exception BAD_PARAM if the givenintdoes not match the value of anySetOverrideTypeinstance
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()
TypeCodeobjects are used:
- in the Dynamic Invocation Interface -- to indicate the types of the actual arguments or the type of the return value.
NamedValueobjects are used to represent arguments and return values. One of their components is anAnyobject which in turn has as one of its components aTypeCodeobject.- by an Interface Repository to represent the type specifications that are part of many OMG IDL declarations
The representation of a
TypeCodeobject is opaque but abstractly aTypeCodeobject consists of:
- a
kindfield which is set to an instance of the classTCKind- zero or more additional fields appropriate for the particular kind. For example the
TypeCodeobject describing the OMG IDL type1onghas kindTCKind.tk_longand no additional fields. TheTypeCodedescribing OMG IDL typesequence<boolean 10>has akindfield with the valueTCKind.tk_sequenceand also fields with the valuesbooleanand10for the type of sequence elements and the length of the sequence.
TypeCodeobjects can be obtained in various ways:
- from a call to the method
Any.insert_Xwhere X is a basic IDL type. This method creates aTypeCodeobject for type X and assigns it to theAnyobject'stypefield.- from invocations of methods in the ORB class
For example the following creates a
TypeCodeobject for astringwith a maximum of 30 characters:org.omg.CORBA.TypeCode tcString = orb.create_string_tc(30);The following creates a
TypeCodeobject for anarrayof fivestrings:org.omg.CORBA.TypeCode tcArray = orb.create_array_tc( 5 TCKind.tk_string);The following creates a
TypeCodeobject for an interface named "Account":org.omg.CORBA.TypeCode tcInterface = orb.create_interface_tc( "thisId" "Account");- as the return value from the
_typemethod inHolderclasses for user-defined IDL types. TheseHolderclasses are generated by theidltojavacompiler.- from a CORBA Interface Repository
Most of the methods in the class
TypeCodeare accessors and the information contained in aTypeCodeobject 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_typeis called on anything other than aunionit will throwBadKindbecause onlyunions have a discriminator. The following list shows which methods apply to which kinds of type codes:These methods may be invoked on all
TypeCodekinds:
equalkindThese methods may be invoked on
objrefstructunionenumaliasexceptionvaluevalue_boxnativeandabstract_interface:
idnameThese methods may be invoked on
structunionenumandexception:
member_countmember_nameThese methods may be invoked on
structunionandexception:
member_type(int index)These methods may be invoked on
union:
member_labeldiscriminator_typedefault_indexThese methods may be invoked on
stringsequenceandarray:
lengthThese methods may be invoked on
aliassequencearrayandvalue_box:
content_typeUnlike other CORBA pseudo-objects
TypeCodeobjects can be passed as general IDL parameters.The methods
parameterandparam_countwhich are deprecated are not mapped.Java IDL extends the CORBA specification to allow all operations permitted on a
structTypeCodeto be permitted on anexceptionTypeCodeas well.@version 1.25 09/09/97
Returns theClass TypeCode, TypeCode content_type()TypeCodeobject that describes the concrete base type of the value type that thisTypeCodeobject describes. Returns null if it doesn't have a concrete base type. @return theTypeCodeobject that describes the concrete base type of the value type that thisTypeCodeobject describes @exceptionthrows org.omg.CORBA.TypeCodePackage.BadKind if this method is invoked on a non-boxed value typeTypeCodeobject @seeCORBApackage comments for unimplemented features
Returns theClass TypeCode, int default_index()TypeCodeobject representing the IDL type for the members of the object described by thisTypeCodeobject. For sequences and arrays it returns the element type. For aliases it returns the original type. Note that multidimensional arrays are represented by nestingTypeCodeobjects one per dimension. For boxed valuetypes it returns the boxed type.The method
content_typecan be invoked on sequence array alias and boxed valuetypeTypeCodeobjects. @return aTypeCodeobject 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 ofTypeCodeobject
Returns the index of the default member or -1 if there is no default member.Class TypeCode, TypeCode discriminator_type()The method
default_indexcan be invoked only on unionTypeCodeobjects. @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-unionTypeCodeobject
Returns aClass TypeCode, boolean equivalent(TypeCode)TypeCodeobject describing all non-default member labels. The methoddiscriminator_typecan be invoked only on unionTypeCodeobjects. @return theTypeCodeobject describing the non-default member labels @exceptionthrows org.omg.CORBA.TypeCodePackage.BadKind if the method is invoked on a non-unionTypeCodeobject
Tests to see if the givenClass TypeCode, short fixed_digits()TypeCodeobject is equivalent to thisTypeCodeobject.Not implemented; see package comments. @param tc the typecode to compare with this typecode @return
@seetrueif the given typecode is equivalent to this typecode;falseotherwiseCORBApackage comments for unimplemented features
Returns the number of digits in the fixed type described by thisClass TypeCode, short fixed_scale()TypeCodeobject. 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 ofTypeCodeobject @seeCORBApackage comments for unimplemented features
Returns the scale of the fixed type described by thisClass TypeCode, TypeCode get_compact_typecode()TypeCodeobject. 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 thisTypeCodeobject describes @throws org.omg.CORBA.TypeCodePackage.BadKind if this method is invoked on an inappropriate kind ofTypeCodeobject @seeCORBApackage comments for unimplemented features
Strips out all optional nameClass TypeCode, String id()&and member name fields butitleaves all alias typecodes intact. @return aTypeCodeobject with optional name and member name fields stripped out except for alias typecodes which are left intact @seeCORBApackage comments for unimplemented features
Retrieves the RepositoryId globally identifying the type of thisClass TypeCode, int length()TypeCodeobject.The method
idcan 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 interfaceTypeCodeobjects always have a RepositoryId. Structure union enumeration and aliasTypeCodeobjects obtained from the Interface Repository or the methodORB.create_operation_listalso always have a RepositoryId. If there is no RepositoryId the method can return an empty string. @return the RepositoryId for thisTypeCodeobject or an empty string if there is no RepositoryID @exceptionthrows org.omg.CORBA.TypeCodePackage.BadKind if the method is invoked on an inappropriate kind ofTypeCodeobject
Returns the number of elements in the type described by thisClass TypeCode, int member_count()TypeCodeobject. 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
lengthcan be invoked on string sequence and arrayTypeCodeobjects. @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 ofTypeCodeobject
Retrieves the number of members in the type described by thisClass TypeCode, Any member_label(int)TypeCodeobject.The method
member_countcan be invoked on structure union and enumerationTypeCodeobjects. 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 thisTypeCodeobject @exceptionthrows org.omg.CORBA.TypeCodePackage.BadKind if the method is invoked on an inappropriate kind ofTypeCodeobject
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_labelcan only be invoked on unionTypeCodeobjects. @param index index of the union member for which the label is being requested @return anAnyobject 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-unionTypeCodeobject
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)TypeCodeobject may not match the name of the member in any particular Repository and may even be an empty string.The method
member_namecan be invoked on structure union and enumerationTypeCodeobjects. 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 ofTypeCodeobject
Retrieves theClass TypeCode, short member_visibility(int)TypeCodeobject describing the type of the member identified by the given index.The method
member_typecan be invoked on structure and unionTypeCodeobjects. 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 theTypeCodeobject 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 ofTypeCodeobject
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()TypeCodeobjects. @param index anintindicating the index into the value @return eitherPRIVATE_MEMBER.valueorPUBLIC_MEMBER.value@exceptionthrows org.omg.CORBA.TypeCodePackage.BadKind if this method is invoked on a non-value typeTypeCodeobject @exceptionthrows org.omg.CORBA.TypeCodePackage.Bounds if the given index is out of bounds @seeCORBApackage comments for unimplemented features
Retrieves the simple name identifying thisClass TypeCode, short type_modifier()TypeCodeobject within its enclosing scope. Since names are local to a Repository the name returned from aTypeCodeobject may not match the name of the type in any particular Repository and may even be an empty string.The method
namecan be invoked on object reference structure union enumeration alias exception valuetype boxed valuetype native and abstract interfaceTypeCodeobjects. @return the name identifying thisTypeCodeobject or an empty string @exceptionthrows org.omg.CORBA.TypeCodePackage.BadKind if the method is invoked on an inappropriate kind ofTypeCodeobject
Returns a constant indicating the modifier of the value type that thisTypeCodeobject describes. The constant returned must be one of the following:VM_NONE.valueVM_ABSTRACT.valueVM_CUSTOM.valueorVM_TRUNCATABLE.value@return a constant describing the value type that thisTypeCodeobject describes @exceptionthrows org.omg.CORBA.TypeCodePackage.BadKind if this method is invoked on a non-value typeTypeCodeobject @seeCORBApackage comments for unimplemented features