VisiBroker for Java

org.omg.DynamicAny
Interface DynStructOperations

All Superinterfaces:
DynAnyOperations
All Known Subinterfaces:
DynStruct
All Known Implementing Classes:
_DynStructStub

public interface DynStructOperations
extends DynAnyOperations

DynStruct objects are associated with struct values and exception values. DynStruct objects can also be used for handling exception values. In that case, members of the exceptions are handled in the same way as members of a struct.


Method Summary
 TCKind current_member_kind()
          current_member_kind returns the TCKind associated with the member at the current position.
 java.lang.String current_member_name()
          The current_member_name operation returns the name of the member at the current position.
 NameDynAnyPair[] get_members_as_dyn_any()
          The get_members_as_dyn_any operation has the same semantics as their Any counterpart, but returns values of type DynAny instead of Any.
 NameValuePair[] get_members()
          The get_members operation returns a sequence of name/value pairs describing the name and the value of each member in the struct associated with a DynStruct object.
 void set_members_as_dyn_any(NameDynAnyPair[] value)
          The set_members_as_dyn_any operation has the same semantics as their Any counterpart, but accepts values of type DynAny instead of Any.
 void set_members(NameValuePair[] value)
          The set_members operation initializes the struct data value associated with a DynStruct object from a sequence of name value pairs.
 
Methods inherited from interface org.omg.DynamicAny.DynAnyOperations
assign, component_count, copy, current_component, destroy, equal, from_any, get_any, get_boolean, get_char, get_double, get_dyn_any, get_float, get_long, get_longlong, get_octet, get_reference, get_short, get_string, get_typecode, get_ulong, get_ulonglong, get_ushort, get_val, get_wchar, get_wstring, insert_any, insert_boolean, insert_char, insert_double, insert_dyn_any, insert_float, insert_long, insert_longlong, insert_octet, insert_reference, insert_short, insert_string, insert_typecode, insert_ulong, insert_ulonglong, insert_ushort, insert_val, insert_wchar, insert_wstring, next, rewind, seek, to_any, type
 

Method Detail

set_members_as_dyn_any

void set_members_as_dyn_any(NameDynAnyPair[] value)
                            throws TypeMismatch,
                                   InvalidValue
The set_members_as_dyn_any operation has the same semantics as their Any counterpart, but accepts values of type DynAny instead of Any.

Throws:
TypeMismatch
InvalidValue

get_members_as_dyn_any

NameDynAnyPair[] get_members_as_dyn_any()
The get_members_as_dyn_any operation has the same semantics as their Any counterpart, but returns values of type DynAny instead of Any.


set_members

void set_members(NameValuePair[] value)
                 throws TypeMismatch,
                        InvalidValue
The set_members operation initializes the struct data value associated with a DynStruct object from a sequence of name value pairs. The operation sets the current position to zero if the passed sequences has non-zero length; otherwise, if an empty sequence is passed, the current position is set to -1. Members must appear in the NameValuePairSeq in the order in which they appear in the IDL specification of the struct. If one or more sequence elements have a type that is not equivalent to the TypeCode of the corresponding member, the operation raises TypeMismatch. If the passed sequence has a number of elements that disagrees with the number of members as indicated by the DynStruct's TypeCode, the operation raises InvalidValue. If member names are supplied in the passed sequence, they must either match the corresponding member name in the DynStruct's TypeCode or must be empty strings, otherwise, the operation raises TypeMismatch. Members must be supplied in the same order as indicated by the DynStruct's TypeCode. (The operation makes no attempt to assign member values based on member names.)

Throws:
TypeMismatch
InvalidValue

get_members

NameValuePair[] get_members()
The get_members operation returns a sequence of name/value pairs describing the name and the value of each member in the struct associated with a DynStruct object. The sequence contains members in the same order as the declaration order of members as indicated by the DynStruct?s TypeCode. The current position is not affected. The member names in the returned sequence will be empty strings if the DynStruct?s TypeCode does not contain member names.


current_member_kind

TCKind current_member_kind()
                           throws TypeMismatch,
                                  InvalidValue
current_member_kind returns the TCKind associated with the member at the current position. If the DynStruct represents an empty exception, the operation raises TypeMismatch. If the current position does not indicate a member, the operation raises InvalidValue.

Throws:
TypeMismatch
InvalidValue

current_member_name

java.lang.String current_member_name()
                                     throws TypeMismatch,
                                            InvalidValue
The current_member_name operation returns the name of the member at the current position. If the DynStruct represents an empty exception, the operation raises TypeMismatch. If the current position does not indicate a member, the operation raises InvalidValue. This operation may return an empty string since the TypeCode of the value being manipulated may not contain the names of members.

Throws:
TypeMismatch
InvalidValue

Borland Software Corporation
http://www.borland.com
100 Enterprise Way
Scotts Valley, CA 95066
Voice: (831) 431-1000
pubsweb@borland.com

Read the latest documentation online