This documentation differs from the official API.
Jadeite adds
extra features to the API including:
variable font sizes,
constructions examples,
placeholders for classes and methods, and auto-generated “See Also” links.
Additionally it
is missing some items found in standard Javadoc documentation, including:
generics type information,
“Deprecated” tags and comments,
“See Also” links,
along with other minor differences.
Please send any questions or feedback to
bam@cs.cmu.edu.
org.omg.DynamicAny
class _DynFixedStub
- All Implemented Interfaces:
- Object, DynFixed
public class _DynFixedStub
extends ObjectImpl
implements DynFixed
DynFixed objects support the manipulation of IDL fixed values.
Because IDL does not have a generic type that can represent fixed types with arbitrary
number of digits and arbitrary scale, the operations use the IDL string type.
Method Summary |
void |
Initializes the value associated with a DynAny object with the value
associated with another DynAny object.
|
int |
Returns the number of components of a DynAny.
|
DynAny |
Creates a new DynAny object whose value is a deep copy of the DynAny on which it is invoked.
|
DynAny |
Returns the DynAny for the component at the current position.
|
void |
Destroys a DynAny object.
|
boolean |
Compares two DynAny values for equality.
|
void |
Initializes the value associated with a DynAny object with the value contained in an any.
|
Any |
Extracts an Any value contained in the Any represented by this DynAny.
|
boolean |
Extracts the boolean value from this DynAny.
|
char |
Extracts the char value from this DynAny.
|
double |
Extracts the double value from this DynAny.
|
DynAny |
Extracts the Any value contained in the Any represented by this DynAny and returns it wrapped
into a new DynAny.
|
float |
Extracts the float value from this DynAny.
|
int |
Extracts the integer value from this DynAny.
|
long |
Extracts the long value from this DynAny.
|
byte |
Extracts the byte value from this DynAny.
|
Object |
Extracts the reference to a CORBA Object from this DynAny.
|
short |
Extracts the short value from this DynAny.
|
String |
Extracts the string value from this DynAny.
|
TypeCode |
Extracts the TypeCode object from this DynAny.
|
int |
Extracts the integer value from this DynAny.
|
long |
Extracts the long value from this DynAny.
|
short |
Extracts the short value from this DynAny.
|
Serializable |
Extracts a Serializable object from this DynAny.
|
String |
Returns the value of a DynFixed.
|
char |
Extracts the long value from this DynAny.
|
String |
Extracts the string value from this DynAny.
|
void |
Inserts an Any value into the Any represented by this DynAny.
|
void |
Inserts a boolean value into the DynAny.
|
void |
Inserts a char value into the DynAny.
|
void |
Inserts a double value into the DynAny.
|
void |
Inserts the Any value contained in the parameter DynAny into the Any represented by this DynAny.
|
void |
Inserts a float value into the DynAny.
|
void |
Inserts an integer value into the DynAny.
|
void |
Inserts a long value into the DynAny.
|
void |
Inserts a byte value into the DynAny.
|
void |
Inserts a reference to a CORBA object into the DynAny.
|
void |
Inserts a short value into the DynAny.
|
void |
Inserts a string value into the DynAny.
|
void |
Inserts a TypeCode object into the DynAny.
|
void |
Inserts an integer value into the DynAny.
|
void |
Inserts a long value into the DynAny.
|
void |
Inserts a short value into the DynAny.
|
void |
Inserts a reference to a Serializable object into this DynAny.
|
void |
Inserts a char value into the DynAny.
|
void |
Inserts a string value into the DynAny.
|
boolean |
Advances the current position to the next component.
|
void |
Is equivalent to seek(0).
|
boolean |
Sets the current position to index.
|
boolean |
Sets the value of the DynFixed.
|
Any |
Creates an any value from a DynAny object.
|
TypeCode |
Returns the TypeCode associated with this DynAny object.
|
String[] |
Retrieves a string array containing the repository identifiers
supported by this ObjectImpl object.
|
Methods inherited from class org.omg.CORBA.portable.ObjectImpl |
equals, hashCode, toString, _create_request, _create_request, _duplicate, _get_delegate, _get_domain_managers, _get_interface_def, _get_policy, _hash, _ids, _invoke, _is_a, _is_equivalent, _is_local, _non_existent, _orb, _release, _releaseReply, _request, _request, _servant_postinvoke, _servant_preinvoke, _set_delegate, _set_policy_override |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
_opsClass
public static final Class _opsClass
-
_DynFixedStub
public _DynFixedStub()
-
assign
public void assign(DynAny dyn_any)
throws TypeMismatch
-
Initializes the value associated with a DynAny object with the value
associated with another DynAny object.
The current position of the target DynAny is set to zero for values that have components
and to -1 for values that do not have components.
- Parameters:
dyn_any
- Throws:
TypeMismatch
component_count
public int component_count()
-
Returns the number of components of a DynAny.
For a DynAny without components, it returns zero.
The operation only counts the components at the top level.
For example, if component_count is invoked on a DynStruct with a single member,
the return value is 1, irrespective of the type of the member.
- For sequences, the operation returns the current number of elements.
- For structures, exceptions, and value types, the operation returns the number of members.
- For arrays, the operation returns the number of elements.
- For unions, the operation returns 2 if the discriminator indicates that a named member is active,
otherwise, it returns 1.
- For DynFixed and DynEnum, the operation returns zero.
copy
public DynAny copy()
-
Creates a new DynAny object whose value is a deep copy of the DynAny on which it is invoked.
The operation is polymorphic, that is, invoking it on one of the types derived from DynAny,
such as DynStruct, creates the derived type but returns its reference as the DynAny base type.
- Returns:
- a deep copy of the DynAny object
current_component
public DynAny current_component()
throws TypeMismatch
-
Returns the DynAny for the component at the current position.
It does not advance the current position, so repeated calls to current_component
without an intervening call to rewind, next, or seek return the same component.
The returned DynAny object reference can be used to get/set the value of the current component.
If the current component represents a complex type, the returned reference can be narrowed
based on the TypeCode to get the interface corresponding to the to the complex type.
Calling current_component on a DynAny that cannot have components,
such as a DynEnum or an empty exception, raises TypeMismatch.
Calling current_component on a DynAny whose current position is -1 returns a nil reference.
The iteration operations, together with current_component, can be used
to dynamically compose an any value. After creating a dynamic any, such as a DynStruct,
current_component and next can be used to initialize all the components of the value.
Once the dynamic value is completely initialized, to_any creates the corresponding any value.
- Throws:
TypeMismatch
destroy
public void destroy()
-
Destroys a DynAny object.
This operation frees any resources used to represent the data value associated with a DynAny object.
It must be invoked on references obtained from one of the creation operations on the ORB interface
or on a reference returned by DynAny.copy() to avoid resource leaks.
Invoking destroy on component DynAny objects (for example, on objects returned by the
current_component operation) does nothing.
Destruction of a DynAny object implies destruction of all DynAny objects obtained from it.
That is, references to components of a destroyed DynAny become invalid.
Invocations on such references raise OBJECT_NOT_EXIST.
It is possible to manipulate a component of a DynAny beyond the life time of the DynAny
from which the component was obtained by making a copy of the component with the copy operation
before destroying the DynAny from which the component was obtained.
equal
public boolean equal(DynAny dyn_any)
-
Compares two DynAny values for equality.
Two DynAny values are equal if their TypeCodes are equivalent and, recursively, all component DynAnys
have equal values.
The current position of the two DynAnys being compared has no effect on the result of equal.
- Parameters:
dyn_any
- Returns:
- true of the DynAnys are equal, false otherwise
from_any
public void from_any(Any value)
throws TypeMismatch,
InvalidValue
-
Initializes the value associated with a DynAny object with the value contained in an any.
The current position of the target DynAny is set to zero for values that have components
and to -1 for values that do not have components.
- Parameters:
value
- Throws:
TypeMismatch
InvalidValue
get_any
public Any get_any()
throws TypeMismatch,
InvalidValue
-
Extracts an Any value contained in the Any represented by this DynAny.
- Throws:
TypeMismatch
InvalidValue
get_boolean
public boolean get_boolean()
throws TypeMismatch,
InvalidValue
-
Extracts the boolean value from this DynAny.
- Throws:
TypeMismatch
InvalidValue
get_char
public char get_char()
throws TypeMismatch,
InvalidValue
-
Extracts the char value from this DynAny.
- Throws:
TypeMismatch
InvalidValue
get_double
public double get_double()
throws TypeMismatch,
InvalidValue
-
Extracts the double value from this DynAny.
- Throws:
TypeMismatch
InvalidValue
get_dyn_any
public DynAny get_dyn_any()
throws TypeMismatch,
InvalidValue
-
Extracts the Any value contained in the Any represented by this DynAny and returns it wrapped
into a new DynAny.
- Throws:
TypeMismatch
InvalidValue
get_float
public float get_float()
throws TypeMismatch,
InvalidValue
-
Extracts the float value from this DynAny.
- Throws:
TypeMismatch
InvalidValue
get_long
public int get_long()
throws TypeMismatch,
InvalidValue
-
Extracts the integer value from this DynAny. The IDL long data type is mapped to the Java int data type.
- Throws:
TypeMismatch
InvalidValue
get_longlong
public long get_longlong()
throws TypeMismatch,
InvalidValue
-
Extracts the long value from this DynAny. The IDL long long data type is mapped to the Java long data type.
- Throws:
TypeMismatch
InvalidValue
get_octet
public byte get_octet()
throws TypeMismatch,
InvalidValue
-
Extracts the byte value from this DynAny. The IDL octet data type is mapped to the Java byte data type.
- Throws:
TypeMismatch
InvalidValue
get_reference
public Object get_reference()
throws TypeMismatch,
InvalidValue
-
Extracts the reference to a CORBA Object from this DynAny.
- Throws:
TypeMismatch
InvalidValue
get_short
public short get_short()
throws TypeMismatch,
InvalidValue
-
Extracts the short value from this DynAny.
- Throws:
TypeMismatch
InvalidValue
get_string
public String get_string()
throws TypeMismatch,
InvalidValue
-
Extracts the string value from this DynAny.
Both bounded and unbounded strings are extracted using this method.
- Throws:
TypeMismatch
InvalidValue
get_typecode
public TypeCode get_typecode()
throws TypeMismatch,
InvalidValue
-
Extracts the TypeCode object from this DynAny.
- Throws:
TypeMismatch
InvalidValue
get_ulong
public int get_ulong()
throws TypeMismatch,
InvalidValue
-
Extracts the integer value from this DynAny. The IDL ulong data type is mapped to the Java int data type.
- Throws:
TypeMismatch
InvalidValue
get_ulonglong
public long get_ulonglong()
throws TypeMismatch,
InvalidValue
-
Extracts the long value from this DynAny.
The IDL unsigned long long data type is mapped to the Java long data type.
- Throws:
TypeMismatch
InvalidValue
get_ushort
public short get_ushort()
throws TypeMismatch,
InvalidValue
-
Extracts the short value from this DynAny. The IDL ushort data type is mapped to the Java short data type.
- Throws:
TypeMismatch
InvalidValue
get_val
public Serializable get_val()
throws TypeMismatch,
InvalidValue
-
Extracts a Serializable object from this DynAny.
The IDL ValueBase type is mapped to the Java Serializable type.
- Throws:
TypeMismatch
InvalidValue
get_value
public String get_value()
-
Returns the value of a DynFixed.
get_wchar
public char get_wchar()
throws TypeMismatch,
InvalidValue
-
Extracts the long value from this DynAny. The IDL wchar data type is mapped to the Java char data type.
- Throws:
TypeMismatch
InvalidValue
get_wstring
public String get_wstring()
throws TypeMismatch,
InvalidValue
-
Extracts the string value from this DynAny.
Both bounded and unbounded strings are extracted using this method.
- Throws:
TypeMismatch
InvalidValue
insert_any
public void insert_any(Any value)
throws TypeMismatch,
InvalidValue
-
Inserts an Any value into the Any represented by this DynAny.
- Parameters:
value
- Throws:
TypeMismatch
InvalidValue
insert_boolean
public void insert_boolean(boolean value)
throws TypeMismatch,
InvalidValue
-
Inserts a boolean value into the DynAny.
- Parameters:
value
- Throws:
TypeMismatch
InvalidValue
insert_char
public void insert_char(char value)
throws TypeMismatch,
InvalidValue
-
Inserts a char value into the DynAny.
- Parameters:
value
- Throws:
TypeMismatch
InvalidValue
insert_double
public void insert_double(double value)
throws TypeMismatch,
InvalidValue
-
Inserts a double value into the DynAny.
- Parameters:
value
- Throws:
TypeMismatch
InvalidValue
insert_dyn_any
public void insert_dyn_any(DynAny value)
throws TypeMismatch,
InvalidValue
-
Inserts the Any value contained in the parameter DynAny into the Any represented by this DynAny.
- Parameters:
value
- Throws:
TypeMismatch
InvalidValue
insert_float
public void insert_float(float value)
throws TypeMismatch,
InvalidValue
-
Inserts a float value into the DynAny.
- Parameters:
value
- Throws:
TypeMismatch
InvalidValue
insert_long
public void insert_long(int value)
throws TypeMismatch,
InvalidValue
-
Inserts an integer value into the DynAny. The IDL long data type is mapped to the Java int data type.
- Parameters:
value
- Throws:
TypeMismatch
InvalidValue
insert_longlong
public void insert_longlong(long value)
throws TypeMismatch,
InvalidValue
-
Inserts a long value into the DynAny. The IDL long long data type is mapped to the Java long data type.
- Parameters:
value
- Throws:
TypeMismatch
InvalidValue
insert_octet
public void insert_octet(byte value)
throws TypeMismatch,
InvalidValue
-
Inserts a byte value into the DynAny. The IDL octet data type is mapped to the Java byte data type.
- Parameters:
value
- Throws:
TypeMismatch
InvalidValue
insert_reference
public void insert_reference(Object value)
throws TypeMismatch,
InvalidValue
-
Inserts a reference to a CORBA object into the DynAny.
- Parameters:
value
- Throws:
TypeMismatch
InvalidValue
insert_short
public void insert_short(short value)
throws TypeMismatch,
InvalidValue
-
Inserts a short value into the DynAny.
- Parameters:
value
- Throws:
TypeMismatch
InvalidValue
insert_string
public void insert_string(String value)
throws TypeMismatch,
InvalidValue
-
Inserts a string value into the DynAny.
Both bounded and unbounded strings are inserted using this method.
- Parameters:
value
- Throws:
TypeMismatch
InvalidValue
insert_typecode
public void insert_typecode(TypeCode value)
throws TypeMismatch,
InvalidValue
-
Inserts a TypeCode object into the DynAny.
- Parameters:
value
- Throws:
TypeMismatch
InvalidValue
insert_ulong
public void insert_ulong(int value)
throws TypeMismatch,
InvalidValue
-
Inserts an integer value into the DynAny. The IDL ulong data type is mapped to the Java int data type.
- Parameters:
value
- Throws:
TypeMismatch
InvalidValue
insert_ulonglong
public void insert_ulonglong(long value)
throws TypeMismatch,
InvalidValue
-
Inserts a long value into the DynAny.
The IDL unsigned long long data type is mapped to the Java long data type.
- Parameters:
value
- Throws:
TypeMismatch
InvalidValue
insert_ushort
public void insert_ushort(short value)
throws TypeMismatch,
InvalidValue
-
Inserts a short value into the DynAny. The IDL ushort data type is mapped to the Java short data type.
- Parameters:
value
- Throws:
TypeMismatch
InvalidValue
insert_val
public void insert_val(Serializable value)
throws TypeMismatch,
InvalidValue
-
Inserts a reference to a Serializable object into this DynAny.
The IDL ValueBase type is mapped to the Java Serializable type.
- Parameters:
value
- Throws:
TypeMismatch
InvalidValue
insert_wchar
public void insert_wchar(char value)
throws TypeMismatch,
InvalidValue
-
Inserts a char value into the DynAny. The IDL wchar data type is mapped to the Java char data type.
- Parameters:
value
- Throws:
TypeMismatch
InvalidValue
insert_wstring
public void insert_wstring(String value)
throws TypeMismatch,
InvalidValue
-
Inserts a string value into the DynAny.
Both bounded and unbounded strings are inserted using this method.
- Parameters:
value
- Throws:
TypeMismatch
InvalidValue
next
public boolean next()
-
Advances the current position to the next component.
The operation returns true while the resulting current position indicates a component, false otherwise.
A false return value leaves the current position at -1.
Invoking next on a DynAny without components leaves the current position at -1 and returns false.
rewind
public void rewind()
-
Is equivalent to seek(0).
seek
public boolean seek(int index)
-
Sets the current position to index. The current position is indexed 0 to n-1, that is,
index zero corresponds to the first component. The operation returns true if the resulting
current position indicates a component of the DynAny and false if index indicates
a position that does not correspond to a component.
Calling seek with a negative index is legal. It sets the current position to -1 to indicate
no component and returns false. Passing a non-negative index value for a DynAny that does not
have a component at the corresponding position sets the current position to -1 and returns false.
- Parameters:
index
set_value
public boolean set_value(String val)
throws TypeMismatch,
InvalidValue
-
Sets the value of the DynFixed.
The val string must contain a fixed string constant in the same format as used for IDL fixed-point literals.
However, the trailing d or D is optional. The return value is true if val can be represented as the DynFixed
without loss of precision. If val has more fractional digits than can be represented in the DynFixed,
fractional digits are truncated and the return value is false.
- Parameters:
val
- Throws:
TypeMismatch
InvalidValue
to_any
public Any to_any()
-
Creates an any value from a DynAny object.
A copy of the TypeCode associated with the DynAny object is assigned to the resulting any.
The value associated with the DynAny object is copied into the any.
- Returns:
- a new Any object with the same value and TypeCode
type
public TypeCode type()
-
Returns the TypeCode associated with this DynAny object.
A DynAny object is created with a TypeCode value assigned to it.
This TypeCode value determines the type of the value handled through the DynAny object.
Note that the TypeCode associated with a DynAny object is initialized at the time the
DynAny is created and cannot be changed during lifetime of the DynAny object.
- Returns:
- The TypeCode associated with this DynAny object
_ids
public String[] _ids()
-
- Overrides:
_ids
in class ObjectImpl
This documentation differs from the official API.
Jadeite adds
extra features to the API including:
variable font sizes,
constructions examples,
placeholders for classes and methods, and auto-generated “See Also” links.
Additionally it
is missing some items found in standard Javadoc documentation, including:
generics type information,
“Deprecated” tags and comments,
“See Also” links,
along with other minor differences.
Please send any questions or feedback to
bam@cs.cmu.edu.
This page displays the
Jadeite version of the documention, which is derived from the offical documentation that contains this copyright notice:
The official Sun™ documentation can be found here at
http://java.sun.com/javase/6/docs/api/.