Package org.epics.pvdata.factory

Class BaseUnion

java.lang.Object

org.epics.pvdata.factory.BaseField

org.epics.pvdata.factory.BaseUnion

All Implemented Interfaces:

Field, Serializable, Union

public class BaseUnion
extends BaseField
implements Union

Base class for implementing an union. It is also a complete implementation.

Author:

mse

Field Summary

Fields inherited from interface org.epics.pvdata.pv.Union

ANY_ID, DEFAULT_ID

Constructor Summary

Constructors

Constructor	Description
BaseUnion()	Constructor for a variant union (aka any type).
BaseUnion(String[] fieldNames, Field[] fields)	Constructor for an union field.
BaseUnion(String id, String[] fieldNames, Field[] fields)	Constructor for an union field.

Method Summary

Modifier and Type	Method	Description
void	deserialize(ByteBuffer buffer, DeserializableControl control)	Deserialize buffer.
boolean	equals(Object obj)
Field	getField(int fieldIndex)	Get a sub fields by index.
<T extends Field> T	getField(Class<T> c, int fieldOffset)	Get a subfield by index.
<T extends Field> T	getField(Class<T> c, String fieldName)	Get the Field for the specified fieldName
Field	getField(String name)	Get the Field for the specified fieldName
int	getFieldIndex(String name)	Get the index of the specified field.
String	getFieldName(int fieldIndex)	Get the name of the subfield by index.
String[]	getFieldNames()	Get the array of the subfield names
Field[]	getFields()	Get a list of union fields (members).
String	getID()	Get the identification string.
int	hashCode()
boolean	isVariant()	Check if this union is variant union (aka any type).
void	serialize(ByteBuffer buffer, SerializableControl control)	Serialize field into given buffer.
void	toString(StringBuilder buf, int indentLevel)	Convert to a string

Methods inherited from class org.epics.pvdata.factory.BaseField

getType, toString, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.epics.pvdata.pv.Field

getType, toString, toString

Constructor Detail

BaseUnion

public BaseUnion()

Constructor for a variant union (aka any type).

BaseUnion

public BaseUnion(String[] fieldNames,
                 Field[] fields)

Constructor for an union field.

Parameters:

fieldNames - The field names for the subfields

fields - The array of nodes definitions for the nodes of the structure.

BaseUnion

public BaseUnion(String id,
                 String[] fieldNames,
                 Field[] fields)

Constructor for an union field.

Parameters:

id - The identification string for the union.

fieldNames - The field names for the subfields

fields - The union fields (members).

Throws:

IllegalArgumentException - if id is null or empty.

Method Detail

getID

public String getID()

Description copied from interface: Field

Get the identification string.

Specified by:

getID in interface Field

Returns:

the identification string, can be empty

getField

public Field getField(String name)

Description copied from interface: Union

Get the Field for the specified fieldName

Specified by:

getField in interface Union

Parameters:

name - the name of the field

Returns:

the Field that describes the field

getFieldIndex

public int getFieldIndex(String name)

Description copied from interface: Union

Get the index of the specified field.

Specified by:

getFieldIndex in interface Union

Parameters:

name - the name of the field

Returns:

the index or -1 if fieldName is not a field in the union

getField

public Field getField(int fieldIndex)

Description copied from interface: Union

Get a sub fields by index.

Specified by:

getField in interface Union

Parameters:

fieldIndex - the field index

Returns:

the field at specified index

getField

public <T extends Field> T getField(Class<T> c,
                                    String fieldName)

Description copied from interface: Union

Get the Field for the specified fieldName

Specified by:

getField in interface Union

Type Parameters:

T - the expected type of the Field of the requested field

Parameters:

c - class object modeling the class T of expected type of the requested field

fieldName - the fieldName

Returns:

the Field or null if the field does not exist, or the field is not of c type

getField

public <T extends Field> T getField(Class<T> c,
                                    int fieldOffset)

Description copied from interface: Union

Get a subfield by index.

Specified by:

getField in interface Union

Type Parameters:

T - the expected type of the Field of the requested field

Parameters:

c - class object modeling the class T of expected type of the requested field

fieldOffset - the index

Returns:

the Field or null if the index is invalid, or the field is not of c type

getFieldNames

public String[] getFieldNames()

Description copied from interface: Union

Get the array of the subfield names

Specified by:

getFieldNames in interface Union

Returns:

the array of the subfield names

getFieldName

public String getFieldName(int fieldIndex)

Description copied from interface: Union

Get the name of the subfield by index.

Specified by:

getFieldName in interface Union

Parameters:

fieldIndex - the field index

Returns:

the name of the field

getFields

public Field[] getFields()

Description copied from interface: Union

Get a list of union fields (members).

Specified by:

getFields in interface Union

Returns:

an array of fields (can be empty), non-null

isVariant

public boolean isVariant()

Description copied from interface: Union

Check if this union is variant union (aka any type).

Specified by:

isVariant in interface Union

Returns:

true if this union is variant union, otherwise false

toString

public void toString(StringBuilder buf,
                     int indentLevel)

Description copied from interface: Field

Convert to a string

Specified by:

toString in interface Field

Specified by:

toString in class BaseField

Parameters:

buf - buffer for the result

indentLevel - the indentation level

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

serialize

public void serialize(ByteBuffer buffer,
                      SerializableControl control)

Description copied from interface: Serializable

Serialize field into given buffer.

Specified by:

serialize in interface Serializable

Parameters:

buffer - the serialization buffer

control - the flush interface

deserialize

public void deserialize(ByteBuffer buffer,
                        DeserializableControl control)

Description copied from interface: Serializable

Deserialize buffer.

Specified by:

deserialize in interface Serializable

Parameters:

buffer - the serialization buffer

control - the deserialization control