Package org.epics.pvdata.factory

Class BasePVUnion

java.lang.Object

org.epics.pvdata.factory.AbstractPVField

org.epics.pvdata.factory.BasePVUnion

All Implemented Interfaces:

PVField, PVUnion, Serializable

public class BasePVUnion
extends AbstractPVField
implements PVUnion

Base class for a PVUnion.

Author:

mse

Field Summary

Fields inherited from class org.epics.pvdata.factory.AbstractPVField

convert

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

UNDEFINED_INDEX

Constructor Summary

Constructors

Constructor	Description
BasePVUnion(Union union)	Constructor.

Method Summary

Modifier and Type	Method	Description
void	deserialize(ByteBuffer buffer, DeserializableControl control)	Deserialize buffer.
boolean	equals(Object obj)
PVField	get()	Get the PVField value stored in the field.
<T extends PVField> T	get(Class<T> c)	Get the PVField value stored in the field.
String	getSelectedFieldName()	Get selected field name.
int	getSelectedIndex()	Get selected field index.
Union	getUnion()	Get the union introspection interface.
int	hashCode()
PVField	select(int index)	Select field (set index) and get the field at the index.
<T extends PVField> T	select(Class<T> c, int index)	Select field (set index) and get the field at the index.
<T extends PVField> T	select(Class<T> c, String fieldName)	Select field (set index) and get the field by given name.
PVField	select(String fieldName)	Select field (set index) and get the field by given name.
void	serialize(ByteBuffer buffer, SerializableControl flusher)	Serialize field into given buffer.
void	set(int index, PVField value)	Set the PVField (by reference!) as field at given index.
void	set(String fieldName, PVField value)	Set the PVField (by reference!) as field by given name.
void	set(PVField value)	Set the PVField (by reference!) as selected field.

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

changeField, getField, getFieldName, getFieldOffset, getFullName, getNextFieldOffset, getNumberFields, getParent, isImmutable, postPut, setData, setImmutable, setPostHandler, toString, 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.PVField

getField, getFieldName, getFieldOffset, getFullName, getNextFieldOffset, getNumberFields, getParent, isImmutable, postPut, setImmutable, setPostHandler, toString, toString, toString

Constructor Detail

BasePVUnion

public BasePVUnion(Union union)

Constructor.

Parameters:

union - the reflection interface for the PVUnion data.

Method Detail

getUnion

public Union getUnion()

Description copied from interface: PVUnion

Get the union introspection interface.

Specified by:

getUnion in interface PVUnion

Returns:

The introspection interface.

get

public PVField get()

Description copied from interface: PVUnion

Get the PVField value stored in the field.

Specified by:

get in interface PVUnion

Returns:

PVField value of field, null if getSelectedIndex() == UNDEFINED_INDEX

get

public <T extends PVField> T get(Class<T> c)

Description copied from interface: PVUnion

Get the PVField value stored in the field.

Specified by:

get in interface PVUnion

Type Parameters:

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

Parameters:

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

Returns:

PVField value of field, null if getSelectedIndex() == UNDEFINED_INDEX

getSelectedIndex

public int getSelectedIndex()

Description copied from interface: PVUnion

Get selected field index.

Specified by:

getSelectedIndex in interface PVUnion

Returns:

selected field index

getSelectedFieldName

public String getSelectedFieldName()

Description copied from interface: PVUnion

Get selected field name.

Specified by:

getSelectedFieldName in interface PVUnion

Returns:

selected field name

select

public PVField select(int index)

Description copied from interface: PVUnion

Select field (set index) and get the field at the index.

Specified by:

select in interface PVUnion

Parameters:

index - index of the field to select

Returns:

corresponding PVField (of undetermined value), null if index == UNDEFINED_INDEX

select

public PVField select(String fieldName)

Description copied from interface: PVUnion

Select field (set index) and get the field by given name.

Specified by:

select in interface PVUnion

Parameters:

fieldName - the name of the field to select.

Returns:

corresponding PVField (of undetermined value).

select

public <T extends PVField> T select(Class<T> c,
                                    int index)

Description copied from interface: PVUnion

Select field (set index) and get the field at the index.

Specified by:

select in interface PVUnion

Type Parameters:

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

Parameters:

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

index - index of the field to select.

Returns:

corresponding PVField (of undetermined value), null if index == UNDEFINED_INDEX

select

public <T extends PVField> T select(Class<T> c,
                                    String fieldName)

Description copied from interface: PVUnion

Select field (set index) and get the field by given name.

Specified by:

select in interface PVUnion

Type Parameters:

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

Parameters:

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

fieldName - the name of the field to select

Returns:

corresponding PVField (of undetermined value)

set

public void set(PVField value)

Description copied from interface: PVUnion

Set the PVField (by reference!) as selected field.

Specified by:

set in interface PVUnion

Parameters:

value - the field to set

set

public void set(int index,
                PVField value)

Description copied from interface: PVUnion

Set the PVField (by reference!) as field at given index. If a value is not a valid union field an IllegalArgumentException exception is thrown. Use select(int) to put by value.

Specified by:

set in interface PVUnion

Parameters:

index - index of a field to put.

value - the field to set.

See Also:

PVUnion.select(int)

set

public void set(String fieldName,
                PVField value)

Description copied from interface: PVUnion

Set the PVField (by reference!) as field by given name. If a value is not a valid union field an IllegalArgumentException exception is thrown. Use select(String) to put by value.

Specified by:

set in interface PVUnion

Parameters:

fieldName - Name of the field to put

value - the field to set

See Also:

PVUnion.select(String)

serialize

public void serialize(ByteBuffer buffer,
                      SerializableControl flusher)

Description copied from interface: Serializable

Serialize field into given buffer.

Specified by:

serialize in interface Serializable

Parameters:

buffer - the serialization buffer

flusher - 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

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object