org.apache.kerby.xdr.type

Class XdrUnion

java.lang.Object

org.apache.kerby.xdr.type.AbstractXdrType<XdrUnion>

org.apache.kerby.xdr.type.XdrUnion

All Implemented Interfaces:

XdrType

public abstract class XdrUnion
extends AbstractXdrType<XdrUnion>

A discriminated union is a type composed of a discriminant followed by a type selected from a set of prearranged types according to the value of the discriminant. The type of discriminant is either "int", "unsigned int", or an enumerated type, such as "bool". The component types are called "arms" of the union and are preceded by the value of the discriminant that implies their encoding. Discriminated unions are declared as follows: union switch (discriminant-declaration) { case discriminant-value-A: arm-declaration-A; case discriminant-value-B: arm-declaration-B; ... default: default-declaration; } identifier; Each "case" keyword is followed by a legal value of the discriminant. The default arm is optional. If it is not specified, then a valid encoding of the union cannot take on unspecified discriminant values. The size of the implied arm is always a multiple of four bytes. The discriminated union is encoded as its discriminant followed by the encoding of the implied arm. 0 1 2 3 +---+---+---+---+---+---+---+---+ | discriminant | implied arm | +---+---+---+---+---+---+---+---+ |----4 bytes----|

Constructor Summary

Constructors

Constructor and Description
XdrUnion(XdrDataType xdrDataType)
XdrUnion(XdrDataType xdrDataType, XdrFieldInfo[] fieldInfos)

Method Summary

Methods

Modifier and Type	Method and Description
void	decode(ByteBuffer content) Decode the content bytes into this type.
protected void	encodeBody(ByteBuffer buffer)
protected int	encodingBodyLength()
protected abstract XdrUnion	fieldsToValues(AbstractXdrType[] fields)
protected abstract AbstractXdrType[]	getAllFields()
protected abstract void	getUnionInstance(XdrType[] fields, XdrFieldInfo[] fieldInfos)
XdrFieldInfo[]	getXdrFieldInfos()

Methods inherited from class org.apache.kerby.xdr.type.AbstractXdrType

decode, encode, encode, encodingLength, getDataType, getValue, setValue

Methods inherited from class java.lang.Object

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

Constructor Detail

XdrUnion

public XdrUnion(XdrDataType xdrDataType)

XdrUnion

public XdrUnion(XdrDataType xdrDataType,
        XdrFieldInfo[] fieldInfos)

Method Detail

getUnionInstance

protected abstract void getUnionInstance(XdrType[] fields,
                    XdrFieldInfo[] fieldInfos)

getXdrFieldInfos

public XdrFieldInfo[] getXdrFieldInfos()

encodingBodyLength

protected int encodingBodyLength()
                          throws IOException

Specified by:

encodingBodyLength in class AbstractXdrType<XdrUnion>

Throws:

IOException

encodeBody

protected void encodeBody(ByteBuffer buffer)
                   throws IOException

Specified by:

encodeBody in class AbstractXdrType<XdrUnion>

Throws:

IOException

decode

public void decode(ByteBuffer content)
            throws IOException

Description copied from interface: XdrType

Decode the content bytes into this type.

Specified by:

decode in interface XdrType

Overrides:

decode in class AbstractXdrType<XdrUnion>

Parameters:

content - The content bytes

Throws:

IOException - e

fieldsToValues

protected abstract XdrUnion fieldsToValues(AbstractXdrType[] fields)

getAllFields

protected abstract AbstractXdrType[] getAllFields()