Package io.permazen

Class PermazenSetField

java.lang.Object

io.permazen.PermazenSchemaItem

io.permazen.PermazenField

io.permazen.PermazenComplexField

io.permazen.PermazenCollectionField

io.permazen.PermazenSetField

public class PermazenSetField
extends PermazenCollectionField

Represents a set field in a PermazenClass.

Method Summary

Modifier and Type	Method	Description
io.permazen.NavigableSetConverter<?,?>	getConverter(PermazenTransaction ptx)	Get a Converter that converts this field's value from what the core database returns to what the Java application expects, or null if no conversion is needed.
PermazenSetField	getDeclaringAnnotation()	Get the Annotation that declared this field.
SetField<?>	getSchemaItem()	Get the corresonding core API database instance.
NavigableSet<?>	getValue(PermazenObject pobj)	Get the Java value of this field in the given Java model object.
<R> R	visit(PermazenFieldSwitch<R> target)	Apply visitor pattern.

Methods inherited from class io.permazen.PermazenCollectionField

getElementField, getSubFields, getTypeToken

Methods inherited from class io.permazen.PermazenComplexField

getSubField

Methods inherited from class io.permazen.PermazenField

getFullName, getGetter, getKey, getPermazenClass

Methods inherited from class io.permazen.PermazenSchemaItem

getName, getSchemaId, getStorageId, toString

Methods inherited from class java.lang.Object

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

Method Details

getDeclaringAnnotation

public PermazenSetField getDeclaringAnnotation()

Description copied from class: PermazenField

Get the Annotation that declared this field.

If this field was auto-generated from an abstract method with no annotation, a non-null Annotation is still returned; it will have all default values.

Overrides:

getDeclaringAnnotation in class PermazenField

Returns:

declaring annotation

getValue

public NavigableSet<?> getValue(PermazenObject pobj)

Description copied from class: PermazenField

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

Specified by:

getValue in class PermazenCollectionField

Parameters:

pobj - object containing this field

Returns:

this field's value in pobj

visit

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

Description copied from class: PermazenField

Apply visitor pattern.

Specified by:

visit in class PermazenField

Type Parameters:

R - visit return type

Parameters:

target - target to invoke

Returns:

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

getSchemaItem

public SetField<?> getSchemaItem()

Description copied from class: PermazenSchemaItem

Get the corresonding core API database instance.

Overrides:

getSchemaItem in class PermazenCollectionField

Returns:

this instance's correpsonding SchemaItem

getConverter

public io.permazen.NavigableSetConverter<?,?> getConverter(PermazenTransaction ptx)

Description copied from class: PermazenField

Get a Converter that converts this field's value from what the core database returns to what the Java application expects, or null if no conversion is needed.

Specified by:

getConverter in class PermazenField

Parameters:

ptx - transaction

Returns:

Converter from core API to Java, or null if no conversion is required