Package org.epics.pvdata.factory

Class AbstractPVArray

java.lang.Object

org.epics.pvdata.factory.AbstractPVField

org.epics.pvdata.factory.AbstractPVArray

All Implemented Interfaces:

PVArray, PVField, Serializable, SerializableArray

Direct Known Subclasses:

AbstractPVComplexArray, AbstractPVScalarArray

public abstract class AbstractPVArray
extends AbstractPVField
implements PVArray

Abstract base class for any PVArray field. Any code that implements a PVArray field for an IOC database should extend this class.

Author:

mrk

Field Summary

Fields

Modifier and Type	Field	Description
protected int	capacity	For use by derived classes.
protected boolean	capacityMutable	For use by derived classes.
protected int	length	For use by derived classes.

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

convert

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractPVArray(Array field)	Constructor that derived classes must call.

Method Summary

Modifier and Type	Method	Description
protected abstract void	allocate(int newCapacity)
boolean	equals(Object obj)
Array	getArray()	Get the Array introspection interface.
int	getCapacity()	Get the current capacity of the array, that is, the allocated number of elements.
int	getLength()	Get the current length of the array.
protected abstract Object	getValue()
protected int	internalGet(int offset, int len, ArrayData<?> data)
protected int	internalPut(int offset, int len, Object from, int fromOffset)
protected void	internalShareData(Object from)
boolean	isCapacityMutable()	Can the capacity be changed?
void	put(int offset, org.epics.util.array.ListNumber list)
void	serialize(ByteBuffer buffer, SerializableControl flusher)	Serialize field into given buffer.
void	setCapacity(int newCapacity)	Set the capacity.
void	setCapacityMutable(boolean isMutable)	Set capacityMutable.
void	setImmutable()	Set the field to be immutable - that is, it can no longer be modified.
void	setLength(int len)	Set the length of the array.
protected abstract void	setValue(Object array)
protected abstract boolean	valueEquals(Object obj)

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

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

Methods inherited from class java.lang.Object

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

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

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

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

deserialize

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

serialize

Field Detail

length

protected int length

For use by derived classes.

capacity

protected int capacity

For use by derived classes.

capacityMutable

protected boolean capacityMutable

For use by derived classes.

Constructor Detail

AbstractPVArray

protected AbstractPVArray(Array field)

Constructor that derived classes must call.

Parameters:

field - the reflection interface

Method Detail

getArray

public Array getArray()

Description copied from interface: PVArray

Get the Array introspection interface.

Specified by:

getArray in interface PVArray

Returns:

the introspection interface

getValue

protected abstract Object getValue()

setValue

protected abstract void setValue(Object array)

allocate

protected abstract void allocate(int newCapacity)

valueEquals

protected abstract boolean valueEquals(Object obj)

setCapacity

public void setCapacity(int newCapacity)

Description copied from interface: PVArray

Set the capacity.

Specified by:

setCapacity in interface PVArray

Parameters:

newCapacity - the new capacity for the array

internalGet

protected int internalGet(int offset,
                          int len,
                          ArrayData<?> data)

internalPut

protected int internalPut(int offset,
                          int len,
                          Object from,
                          int fromOffset)

put

public void put(int offset,
                org.epics.util.array.ListNumber list)

internalShareData

protected void internalShareData(Object from)

setImmutable

public void setImmutable()

Description copied from interface: PVField

Set the field to be immutable - that is, it can no longer be modified. This is permanent. Once done the field cannot be made mutable.

Specified by:

setImmutable in interface PVField

Overrides:

setImmutable in class AbstractPVField

isCapacityMutable

public boolean isCapacityMutable()

Description copied from interface: PVArray

Can the capacity be changed?

Specified by:

isCapacityMutable in interface PVArray

Returns:

whether it can be modified

setCapacityMutable

public void setCapacityMutable(boolean isMutable)

Description copied from interface: PVArray

Set capacityMutable.

Specified by:

setCapacityMutable in interface PVArray

Parameters:

isMutable - the new value for capacityMutable

getCapacity

public int getCapacity()

Description copied from interface: PVArray

Get the current capacity of the array, that is, the allocated number of elements.

Specified by:

getCapacity in interface PVArray

Returns:

the capacity

getLength

public int getLength()

Description copied from interface: PVArray

Get the current length of the array.

Specified by:

getLength in interface PVArray

Returns:

the current length of the array

setLength

public void setLength(int len)

Description copied from interface: PVArray

Set the length of the array.

Specified by:

setLength in interface PVArray

Parameters:

len - the new length of the array

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

equals

public boolean equals(Object obj)

Overrides:

equals in class Object