org.jinterop.dcom.core

Class JIUnion

java.lang.Object

org.jinterop.dcom.core.JIUnion

All Implemented Interfaces:

Serializable

public final class JIUnion
extends Object
implements Serializable

This class represents the Union data type. Its usage is dictated by the discriminant which acts as a "switch" to select the correct member to be serialized\deserialzed.

Sample Usage :-
JIUnion forTypeDesc = new JIUnion(Short.class);
JIPointer ptrToTypeDesc = new JIPointer(typeDesc);
JIPointer ptrToArrayDesc = new JIPointer(arrayDesc);
forTypeDesc.addMember(TypeDesc.VT_PTR,ptrToTypeDesc);
forTypeDesc.addMember(TypeDesc.VT_SAFEARRAY,ptrToTypeDesc);
forTypeDesc.addMember(TypeDesc.VT_CARRAY,ptrToArrayDesc);
forTypeDesc.addMember(TypeDesc.VT_USERDEFINED,Integer.class);

The TypeDesc.VT_PTR is an Integer and is used as a discriminant to select ptrTypeDesc, TypeDesc.VT_CARRAY chooses ptrArrayDesc.

Since:

1.0

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
JIUnion(Class discriminantClass) Creates an object with discriminant type specified.

Method Summary

Modifier and Type	Method and Description
void	addMember(Object discriminant, JIStruct member) Adds a member to this Union.
void	addMember(Object discriminant, Object member) Adds a member to this Union.
Map	getMembers() Returns the discriminant Vs there members Map.
void	removeMember(Object discriminant) Removes the entry , identified by it's discriminant from the parameter list of the union.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

JIUnion

public JIUnion(Class discriminantClass)

Creates an object with discriminant type specified. Used only during deserializing the union. Can only be of the type Integer,Short,Boolean or Character.

Parameters:

discriminantClass -

Throws:

IllegalArgumentException - if the discriminantClass is not of the type as specified above.

Method Detail

addMember

public void addMember(Object discriminant,
                      Object member)
               throws JIException

Adds a member to this Union. The member is distinguished using the discriminant.

Parameters:

discriminant -

member -

Throws:

JIException

IllegalArgumentException - if any parameter is null

addMember

public void addMember(Object discriminant,
                      JIStruct member)
               throws JIException

Adds a member to this Union. The member is distinguished using the discriminant.

Parameters:

discriminant -

member -

Throws:

JIException

IllegalArgumentException - if discriminant is null

removeMember

public void removeMember(Object discriminant)

Removes the entry , identified by it's discriminant from the parameter list of the union.

Parameters:

discriminant -

getMembers

public Map getMembers()

Returns the discriminant Vs there members Map.

Returns: