io.permazen.schema

Class SchemaField

java.lang.Object

io.permazen.util.AbstractXMLStreaming

io.permazen.schema.AbstractSchemaItem

io.permazen.schema.SchemaField

All Implemented Interfaces:

Cloneable

Direct Known Subclasses:

ComplexSchemaField, CounterSchemaField, SimpleSchemaField

public abstract class SchemaField
extends AbstractSchemaItem

A field in a SchemaObjectType.

Constructor Summary

Constructors

Constructor and Description
SchemaField()

Method Summary

Modifier and Type	Method and Description
SchemaField	clone() Deep-clone this instance.
boolean	isLockedDown() Determine whether this instance is locked down.
void	lockDown() Lock down this instance.
String	toString()
abstract <R> R	visit(SchemaFieldSwitch<R> target) Apply visitor pattern.

Methods inherited from class io.permazen.schema.AbstractSchemaItem

differencesFrom, equals, getName, getStorageId, hashCode, 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

SchemaField

public SchemaField()

Method Detail

visit

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

Apply visitor pattern.

Type Parameters:

R - visitor return type

Parameters:

target - target to invoke

Returns:

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

Throws:

NullPointerException - if target is null

toString

public String toString()

Overrides:

toString in class AbstractSchemaItem

clone

public SchemaField clone()

Deep-clone this instance.

The returned instance will not be locked down.

Overrides:

clone in class AbstractSchemaItem

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