org.omg.DynamicAny
Interface DynUnionOperations

All Superinterfaces:
DynAnyOperations
All Known Subinterfaces:
DynUnion
All Known Implementing Classes:
_DynUnionStub

public interface DynUnionOperations
extends DynAnyOperations

Defines the operations, applicable to the DynUnion. The DynUnion has only two valid positions:

The size of the union is normally 2. If the discriminator value defines no valid variant, the union consists of discriminator only, having the size 1.


Method Summary
 TCKind discriminator_kind()
          Get the kind of the union descriminator.
 DynAny get_discriminator()
          Get the value of discriminator, defining which content variant (member) is active.
 boolean has_no_active_member()
          Returns true if the union has no active member.
 TCKind member_kind()
          Returns the kind of the currently active union member.
 String member_name()
          Returns the name of the currently active union member.
 DynAny member()
          Get the current variant of the union content.
 void set_discriminator(DynAny aDiscriminator)
          Set the value of discriminator, activating the member variant that is consistent with the discriminator value.
 void set_to_default_member()
          Set the discriminator to default value.
 void set_to_no_active_member()
          Set the discriminator to value that does not correspond any content variant (any union case label).
 
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

get_discriminator

DynAny get_discriminator()

Get the value of discriminator, defining which content variant (member) is active.

In the current implementation, the later changes on the returned value alter the state of the union via implemented internal listener.


set_discriminator

void set_discriminator(DynAny aDiscriminator)
                       throws TypeMismatch

Set the value of discriminator, activating the member variant that is consistent with the discriminator value. If the current member variant matches the discriminator being set, it is unchanged. Otherwise, it is replaced by the matching member variant with fields, initialised to default values. The current position is set to 0 if the discriminator value does not match any member variant. Otherwise, the current position is set to 1, index of the member variant.

Throws:
TypeMismatch - if the discriminator has a wrong type of this union.

discriminator_kind

TCKind discriminator_kind()
Get the kind of the union descriminator.

Returns:
the TCKind value of the discriminator typecode.

member

DynAny member()
              throws InvalidValue
Get the current variant of the union content.

Returns:
the current member of the union. This reference is only valid as long as the current member does not change.
Throws:
InvalidValue - if the union has no active member.

member_kind

TCKind member_kind()
                   throws InvalidValue
Returns the kind of the currently active union member.

Returns:
the TCKind value of the union member.
Throws:
InvalidValue - if the union has no active member.

member_name

String member_name()
                   throws InvalidValue
Returns the name of the currently active union member.

Returns:
the TCKind value of the union member.
Throws:
InvalidValue - if the union has no active member.

has_no_active_member

boolean has_no_active_member()
Returns true if the union has no active member. This happens if If the discriminator value defines no valid variant. Such union consists of discriminator only, having the size 1.


set_to_default_member

void set_to_default_member()
                           throws TypeMismatch
Set the discriminator to default value. The current position is set to 0. This also sets the content variant to the default variant, and the size of the union becomes 2.

Throws:
TypeMismatch - if the default case is not defined for this union.

set_to_no_active_member

void set_to_no_active_member()
                             throws TypeMismatch
Set the discriminator to value that does not correspond any content variant (any union case label). The current position is set to 0. The size of the union becomes 0.

Throws:
TypeMismatch - if the union has explicit default case.