io.permazen.core

Class MapField<K,V>

java.lang.Object

io.permazen.core.SchemaItem

io.permazen.core.Field<T>

io.permazen.core.ComplexField<NavigableMap<K,V>>

io.permazen.core.MapField<K,V>

Type Parameters:

K - Map key type

V - Map value type

public class MapField<K,V>
extends ComplexField<NavigableMap<K,V>>

Map field.

Field Summary

Fields

Modifier and Type	Field and Description
static String	KEY_FIELD_NAME
static String	VALUE_FIELD_NAME

Fields inherited from class io.permazen.core.SchemaItem

NAME_PATTERN

Method Summary

Modifier and Type	Method and Description
SimpleField<K>	getKeyField() Get the key field.
List<SimpleField<?>>	getSubFields() Get the sub-field(s) associated with this instance, ordered according to their meaning.
NavigableMap<K,V>	getValue(Transaction tx, ObjId id) Get the value of this field in the given object.
SimpleField<V>	getValueField() Get the value field.
boolean	hasDefaultValue(Transaction tx, ObjId id) Determine if this field in the specified object has its default value in the specified Transaction.
String	toString()
<R> R	visit(FieldSwitch<R> target) Apply visitor pattern.

Methods inherited from class io.permazen.core.Field

getTypeToken

Methods inherited from class io.permazen.core.SchemaItem

getName, getSchema, getStorageId

Methods inherited from class java.lang.Object

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

Field Detail

KEY_FIELD_NAME

public static final String KEY_FIELD_NAME

See Also:

Constant Field Values

VALUE_FIELD_NAME

public static final String VALUE_FIELD_NAME

See Also:

Constant Field Values

Method Detail

getKeyField

public SimpleField<K> getKeyField()

Get the key field.

Returns:

map key field

getValueField

public SimpleField<V> getValueField()

Get the value field.

Returns:

map value field

getSubFields

public List<SimpleField<?>> getSubFields()

Description copied from class: ComplexField

Get the sub-field(s) associated with this instance, ordered according to their meaning.

Specified by:

getSubFields in class ComplexField<NavigableMap<K,V>>

Returns:

unmodifiable list of simple fields

getValue

public NavigableMap<K,V> getValue(Transaction tx,
                                  ObjId id)

Description copied from class: Field

Get the value of this field in the given object. Does not alter the schema version of the object.

Specified by:

getValue in class Field<NavigableMap<K,V>>

Parameters:

tx - transaction

id - object id

Returns:

this field's value in the specified object

hasDefaultValue

public boolean hasDefaultValue(Transaction tx,
                               ObjId id)

Description copied from class: Field

Determine if this field in the specified object has its default value in the specified Transaction.

Specified by:

hasDefaultValue in class Field<NavigableMap<K,V>>

Parameters:

tx - Transaction containing field state

id - object ID

Returns:

true if this field is set to its initial default value in object id, otherwise false

toString

public String toString()

Specified by:

toString in class SchemaItem

visit

public <R> R visit(FieldSwitch<R> target)

Description copied from class: Field

Apply visitor pattern.

Specified by:

visit in class Field<NavigableMap<K,V>>

Type Parameters:

R - visitor return type

Parameters:

target - target to invoke

Returns:

value from the method of target corresponding to this instance's type