io.permazen.schema

Class SimpleSchemaField

java.lang.Object

io.permazen.util.AbstractXMLStreaming

io.permazen.schema.AbstractSchemaItem

io.permazen.schema.SchemaField

io.permazen.schema.SimpleSchemaField

All Implemented Interfaces:

DiffGenerating<SimpleSchemaField>, Cloneable

Direct Known Subclasses:

AbstractEnumSchemaField, ReferenceSchemaField

public class SimpleSchemaField
extends SchemaField
implements DiffGenerating<SimpleSchemaField>

A simple field in a SchemaObjectType.

Constructor Summary

Constructors

Constructor and Description
SimpleSchemaField()

Method Summary

Modifier and Type	Method and Description
SimpleSchemaField	clone() Deep-clone this instance.
Diffs	differencesFrom(SimpleSchemaField that) Detect the differences of this instance when compared to the given instance.
boolean	equals(Object obj)
long	getEncodingSignature() Get the encoding signature associated with this field's type.
String	getType() Get the name of this field's type.
int	hashCode()
boolean	isIndexed() Get whether this field is indexed or not.
boolean	isLockedDown() Determine whether this instance is locked down.
void	lockDown() Lock down this instance.
void	setEncodingSignature(long encodingSignature)
void	setIndexed(boolean indexed)
void	setType(String type)
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

SimpleSchemaField

public SimpleSchemaField()

Method Detail

getType

public String getType()

Get the name of this field's type. For example "int" for primitive integer type, "java.util.Date" for the built-in Date type, any custom type name, etc.

Returns:

field type name

setType

public void setType(String type)

isIndexed

public boolean isIndexed()

Get whether this field is indexed or not.

Returns:

true if this field is indexed

setIndexed

public void setIndexed(boolean indexed)

getEncodingSignature

public long getEncodingSignature()

Get the encoding signature associated with this field's type.

Returns:

this field's encoding signature

See Also:

FieldType

setEncodingSignature

public void setEncodingSignature(long encodingSignature)

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(SimpleSchemaField that)

Description copied from interface: DiffGenerating

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

Specified by:

differencesFrom in interface DiffGenerating<SimpleSchemaField>

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 SimpleSchemaField clone()

Deep-clone this instance.

The returned instance will not be locked down.

Overrides:

clone in class SchemaField

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