io.permazen.schema

Class AbstractSchemaItem

java.lang.Object

io.permazen.util.AbstractXMLStreaming

io.permazen.schema.AbstractSchemaItem

All Implemented Interfaces:

Cloneable

Direct Known Subclasses:

SchemaCompositeIndex, SchemaField, SchemaObjectType

public abstract class AbstractSchemaItem
extends AbstractXMLStreaming

Common superclass for SchemaObjectType and SchemaField.

Constructor Summary

Constructors

Constructor and Description
AbstractSchemaItem()

Method Summary

Modifier and Type	Method and Description
protected AbstractSchemaItem	clone() Deep-clone this instance.
protected Diffs	differencesFrom(AbstractSchemaItem that)
boolean	equals(Object obj)
String	getName() Get the name associated with this instance, if any.
int	getStorageId() Get the storage ID associated with this instance.
int	hashCode()
boolean	isLockedDown() Determine whether this instance is locked down.
void	lockDown() Lock down this instance.
void	setName(String name)
void	setStorageId(int storageId)
String	toString()

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

AbstractSchemaItem

public AbstractSchemaItem()

Method Detail

getName

public String getName()

Get the name associated with this instance, if any.

Returns:

the name of this instance, or null if it has none

setName

public void setName(String name)

getStorageId

public int getStorageId()

Get the storage ID associated with this instance. Storage IDs must be positive values.

Returns:

the storage ID for this instance

setStorageId

public void setStorageId(int storageId)

differencesFrom

protected Diffs differencesFrom(AbstractSchemaItem that)

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

protected AbstractSchemaItem clone()

Deep-clone this instance.

The returned instance will not be locked down.

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