Package com.igormaznitsa.jbbp.model

Class JBBPFieldArrayStruct

java.lang.Object

com.igormaznitsa.jbbp.model.JBBPAbstractField

com.igormaznitsa.jbbp.model.JBBPAbstractArrayField<JBBPFieldStruct>

com.igormaznitsa.jbbp.model.JBBPFieldArrayStruct

All Implemented Interfaces:

JBBPNamedField, Serializable, Iterable<JBBPFieldStruct>

public final class JBBPFieldArrayStruct
extends JBBPAbstractArrayField<JBBPFieldStruct>

Describes a structure array. It doesn't support operations to get an array value as a numeric one.

Since:

1.0

See Also:

• Serialized Form

Field Summary

Fields inherited from class com.igormaznitsa.jbbp.model.JBBPAbstractField

fieldNameInfo, payload

Constructor Summary

Constructors

Constructor	Description
JBBPFieldArrayStruct(JBBPNamedFieldInfo name, JBBPFieldStruct[] array)	The Constructor.

Method Summary

Modifier and Type	Method	Description
JBBPFieldStruct[]	getArray()	Get the value array.
JBBPFieldStruct	getElementAt(int index)	Get element from the array for its index.
String	getTypeAsString()	Get the field type in string representation.
Object	getValueArrayAsObject(boolean reverseBits)	Get the value array as an object.
int	size()	Get number of elements in the array.

Methods inherited from class com.igormaznitsa.jbbp.model.JBBPAbstractArrayField

iterator

Methods inherited from class com.igormaznitsa.jbbp.model.JBBPAbstractField

getFieldName, getFieldPath, getNameInfo, getPayload, setPayload

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Details

JBBPFieldArrayStruct

public JBBPFieldArrayStruct(JBBPNamedFieldInfo name,
 JBBPFieldStruct[] array)

The Constructor.

Parameters:

name - a field name info, it can be null

array - a value array, it must not be null

Method Details

getArray

public JBBPFieldStruct[] getArray()

Get the value array.

Returns:

the value array as a structure array

size

public int size()

Description copied from class: JBBPAbstractArrayField

Get number of elements in the array.

Specified by:

size in class JBBPAbstractArrayField<JBBPFieldStruct>

Returns:

the array size

getElementAt

public JBBPFieldStruct getElementAt(int index)

Description copied from class: JBBPAbstractArrayField

Get element from the array for its index.

Specified by:

getElementAt in class JBBPAbstractArrayField<JBBPFieldStruct>

Parameters:

index - the array index

Returns:

the array element for its index

getValueArrayAsObject

public Object getValueArrayAsObject(boolean reverseBits)

Description copied from class: JBBPAbstractArrayField

Get the value array as an object.

Specified by:

getValueArrayAsObject in class JBBPAbstractArrayField<JBBPFieldStruct>

Parameters:

reverseBits - reverse bit order in values

Returns:

the value array as an object

getTypeAsString

public String getTypeAsString()

Description copied from class: JBBPAbstractField

Get the field type in string representation.

Specified by:

getTypeAsString in class JBBPAbstractField

Returns:

the string representation of field type, like 'int', 'long', 'bool [123]'