Package io.permazen.core

Class SetField<E>

java.lang.Object

io.permazen.core.SchemaItem

io.permazen.core.Field<T>

io.permazen.core.ComplexField<C>

io.permazen.core.CollectionField<NavigableSet<E>,E>

io.permazen.core.SetField<E>

Type Parameters:

E - Java type for the set elements

public class SetField<E>
extends CollectionField<NavigableSet<E>,E>

Set field.

Field Summary

Fields inherited from class io.permazen.core.CollectionField

ELEMENT_FIELD_NAME

Method Summary

Modifier and Type	Method	Description
SetElementIndex<E>	getElementIndex()	Get the index on this fields's "element" sub-field.
ByteData	getKey(ObjId id, E element)	Get the key in the underlying key/value store corresponding to this field in the specified object and the specified element.
NavigableSet<E>	getValue(Transaction tx, ObjId id)	Get the value of this field in the given object.
String	toString()
<R> R	visit(FieldSwitch<R> target)	Apply visitor pattern.

Methods inherited from class io.permazen.core.CollectionField

getElementField, getSubFields, hasDefaultValue

Methods inherited from class io.permazen.core.Field

getFullName, getKey, getObjType, getTypeToken

Methods inherited from class io.permazen.core.SchemaItem

getName, getSchema, getSchemaId, getStorageId

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Details

getElementIndex

public SetElementIndex<E> getElementIndex()

Description copied from class: CollectionField

Get the index on this fields's "element" sub-field.

Overrides:

getElementIndex in class CollectionField<NavigableSet<E>,E>

Returns:

the index on this field's "element" sub-field

getValue

public NavigableSet<E> getValue(Transaction tx,
 ObjId id)

Description copied from class: Field

Get the value of this field in the given object. Does not alter the schema of the object.

Specified by:

getValue in class CollectionField<NavigableSet<E>,E>

Parameters:

tx - transaction

id - object id

Returns:

this field's value in the specified object

getKey

public ByteData getKey(ObjId id,
 E element)

Get the key in the underlying key/value store corresponding to this field in the specified object and the specified element.

Parameters:

id - object ID

element - set element

Returns:

the corresponding KVDatabase key

Throws:

IllegalArgumentException - if id is null or has the wrong object type

See Also:

• KVTransaction.watchKey()

visit

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

Description copied from class: Field

Apply visitor pattern.

Specified by:

visit in class Field<NavigableSet<E>>

Type Parameters:

R - visitor return type

Parameters:

target - target to invoke

Returns:

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

toString

public String toString()

Specified by:

toString in class SchemaItem