org.openfast.extensions

Class MapScalar

java.lang.Object

org.openfast.SimpleNode

org.openfast.template.Field

org.openfast.extensions.MapScalar

All Implemented Interfaces:

Serializable, Node

public class MapScalar
extends Field

See Also:

Serialized Form

Field Summary

Fields inherited from class org.openfast.template.Field

id, key, optional

Fields inherited from class org.openfast.SimpleNode

attributes, name

Constructor Summary

Constructors

Constructor and Description
MapScalar(QName name, boolean optional, QName key)

Method Summary

Methods

Modifier and Type	Method and Description
FieldValue	createValue(String value) createValue method declaration
FieldValue	decode(InputStream in, Group template, Context context, BitVectorReader presenceMapReader) FieldValue decode method declaration
byte[]	encode(FieldValue value, Group template, Context context, BitVectorBuilder presenceMapBuilder) byte[] encode method declaration
String	getTypeName() getTypeName method declaration
Class	getValueType() getValueType method declaration
boolean	isPresenceMapBitSet(byte[] encoding, FieldValue fieldValue) isPresenceMapBitSet method declaration
boolean	usesPresenceMapBit() usesPresenceMapBit method declaration

Methods inherited from class org.openfast.template.Field

getId, getKey, getName, getQName, getTemplate, isOptional, isPresent, setId, setKey, setMessageTemplate

Methods inherited from class org.openfast.SimpleNode

addNode, getAttribute, getAttributes, getChildren, getNodeName, getNodes, hasAttribute, hasChild, setAttribute

Methods inherited from class java.lang.Object

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

Constructor Detail

MapScalar

public MapScalar(QName name,
         boolean optional,
         QName key)

Method Detail

createValue

public FieldValue createValue(String value)

Description copied from class: Field

createValue method declaration

Specified by:

createValue in class Field

Parameters:

value - The string of the FieldValue that is to be created

decode

public FieldValue decode(InputStream in,
                Group template,
                Context context,
                BitVectorReader presenceMapReader)

Description copied from class: Field

FieldValue decode method declaration

Specified by:

decode in class Field

Parameters:

in - The inputStream to be decoded

template - The Group object to be decoded

context - The previous object to keep the data in sync

encode

public byte[] encode(FieldValue value,
            Group template,
            Context context,
            BitVectorBuilder presenceMapBuilder)

Description copied from class: Field

byte[] encode method declaration

Specified by:

encode in class Field

Parameters:

value - The FieldValue object to be encoded

template - The Group object to be encoded

context - The previous object to keep the data in sync

presenceMapBuilder - The BitVectorBuilder object to be encoded

getTypeName

public String getTypeName()

Description copied from class: Field

getTypeName method declaration

Specified by:

getTypeName in class Field

getValueType

public Class getValueType()

Description copied from class: Field

getValueType method declaration

Specified by:

getValueType in class Field

isPresenceMapBitSet

public boolean isPresenceMapBitSet(byte[] encoding,
                          FieldValue fieldValue)

Description copied from class: Field

isPresenceMapBitSet method declaration

Specified by:

isPresenceMapBitSet in class Field

Parameters:

encoding - The byte array to check if it is present

fieldValue - The fieldValue object

usesPresenceMapBit

public boolean usesPresenceMapBit()

Description copied from class: Field

usesPresenceMapBit method declaration

Specified by:

usesPresenceMapBit in class Field