io.permazen.schema

Class MapSchemaField

java.lang.Object

io.permazen.util.AbstractXMLStreaming

io.permazen.schema.AbstractSchemaItem

io.permazen.schema.SchemaField

io.permazen.schema.ComplexSchemaField

io.permazen.schema.MapSchemaField

All Implemented Interfaces:

DiffGenerating<MapSchemaField>, Cloneable

public class MapSchemaField
extends ComplexSchemaField
implements DiffGenerating<MapSchemaField>

A map field in one version of a SchemaObjectType.

Constructor Summary

Constructors

Constructor and Description
MapSchemaField()

Method Summary

Modifier and Type	Method and Description
MapSchemaField	clone() Deep-clone this instance.
Diffs	differencesFrom(MapSchemaField that) Detect the differences of this instance when compared to the given instance.
boolean	equals(Object obj)
SimpleSchemaField	getKeyField()
Map<String,SimpleSchemaField>	getSubFields()
SimpleSchemaField	getValueField()
int	hashCode()
boolean	isLockedDown() Determine whether this instance is locked down.
void	lockDown() Lock down this instance.
void	setKeyField(SimpleSchemaField keyField)
void	setValueField(SimpleSchemaField valueField)
String	toString()
<R> R	visit(SchemaFieldSwitch<R> target) Apply visitor pattern.

Methods inherited from class io.permazen.schema.AbstractSchemaItem

differencesFrom, getName, getStorageId, setName, setStorageId

Methods inherited from class io.permazen.util.AbstractXMLStreaming

expect, expectClose, getAttr, getAttr, getBooleanAttr, getBooleanAttr, getIntAttr, getIntAttr, getLongAttr, newInvalidAttributeException, next, skip, writeElement

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

MapSchemaField

public MapSchemaField()

Method Detail

getKeyField

public SimpleSchemaField getKeyField()

setKeyField

public void setKeyField(SimpleSchemaField keyField)

getValueField

public SimpleSchemaField getValueField()

setValueField

public void setValueField(SimpleSchemaField valueField)

getSubFields

public Map<String,SimpleSchemaField> getSubFields()

Specified by:

getSubFields in class ComplexSchemaField

visit

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

Description copied from class: SchemaField

Apply visitor pattern.

Specified by:

visit in class SchemaField

Type Parameters:

R - visitor return type

Parameters:

target - target to invoke

Returns:

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

differencesFrom

public Diffs differencesFrom(MapSchemaField that)

Description copied from interface: DiffGenerating

Detect the differences of this instance when compared to the given instance.

Specified by:

differencesFrom in interface DiffGenerating<MapSchemaField>

Parameters:

that - other instance

Returns:

differences; will be empty if there are none detected

toString

public String toString()

Overrides:

toString in class SchemaField

equals

public boolean equals(Object obj)

Overrides:

equals in class AbstractSchemaItem

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractSchemaItem

clone

public MapSchemaField clone()

Deep-clone this instance.

The returned instance will not be locked down.

Overrides:

clone in class ComplexSchemaField

lockDown

public void lockDown()

Lock down this instance.

Once locked down, any attempts to modify this instance (and all associated objects) will result in a IllegalStateException.

isLockedDown

public boolean isLockedDown()

Determine whether this instance is locked down.

Returns:

true if instance is locked down, otherwise false