io.permazen.schema

Class CollectionSchemaField

java.lang.Object

io.permazen.util.AbstractXMLStreaming

io.permazen.schema.AbstractSchemaItem

io.permazen.schema.SchemaField

io.permazen.schema.ComplexSchemaField

io.permazen.schema.CollectionSchemaField

All Implemented Interfaces:

Cloneable

Direct Known Subclasses:

ListSchemaField, SetSchemaField

public abstract class CollectionSchemaField
extends ComplexSchemaField

A collection field in one version of a SchemaObjectType.

Constructor Summary

Constructors

Constructor and Description
CollectionSchemaField()

Method Summary

Modifier and Type	Method and Description
CollectionSchemaField	clone() Deep-clone this instance.
protected Diffs	differencesFrom(CollectionSchemaField that)
boolean	equals(Object obj)
SimpleSchemaField	getElementField()
Map<String,SimpleSchemaField>	getSubFields()
int	hashCode()
boolean	isLockedDown() Determine whether this instance is locked down.
void	lockDown() Lock down this instance.
void	setElementField(SimpleSchemaField elementField)
String	toString()

Methods inherited from class io.permazen.schema.SchemaField

visit

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

CollectionSchemaField

public CollectionSchemaField()

Method Detail

getElementField

public SimpleSchemaField getElementField()

setElementField

public void setElementField(SimpleSchemaField elementField)

getSubFields

public Map<String,SimpleSchemaField> getSubFields()

Specified by:

getSubFields in class ComplexSchemaField

differencesFrom

protected Diffs differencesFrom(CollectionSchemaField that)

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 CollectionSchemaField 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