Package io.permazen

Class PermazenEnumField

java.lang.Object

io.permazen.PermazenSchemaItem

io.permazen.PermazenField

io.permazen.PermazenSimpleField

io.permazen.PermazenEnumField

public class PermazenEnumField
extends PermazenSimpleField

Represents an Enum field in a PermazenClass.

Method Summary

Modifier and Type	Method	Description
Converter<EnumValue,Enum<?>>	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.
Class<? extends Enum<?>>	getEnumType()	Get the Enum type that this field uses.
EnumField	getSchemaItem()	Get the corresonding core API database instance.
TypeToken<? extends Enum<?>>	getTypeToken()	Get the type of this field.
<R> R	visit(PermazenFieldSwitch<R> target)	Apply visitor pattern.

Methods inherited from class io.permazen.PermazenSimpleField

getDeclaringAnnotation, getEncoding, getFullName, getIndex, getParentField, getSetter, getValue, isIndexed, isSubField, setValue

Methods inherited from class io.permazen.PermazenField

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

visit

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

Description copied from class: PermazenField

Apply visitor pattern.

Overrides:

visit in class PermazenSimpleField

Type Parameters:

R - visit return type

Parameters:

target - target to invoke

Returns:

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

getTypeToken

public TypeToken<? extends Enum<?>> getTypeToken()

Description copied from class: PermazenSimpleField

Get the type of this field.

Overrides:

getTypeToken in class PermazenSimpleField

Returns:

this field's Java type

getSchemaItem

public EnumField getSchemaItem()

Description copied from class: PermazenSchemaItem

Get the corresonding core API database instance.

Overrides:

getSchemaItem in class PermazenSimpleField

Returns:

this instance's correpsonding SchemaItem

getEnumType

public Class<? extends Enum<?>> getEnumType()

Get the Enum type that this field uses.

Returns:

this field's Enum type

getConverter

public Converter<EnumValue,Enum<?>> 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.

Overrides:

getConverter in class PermazenSimpleField

Parameters:

ptx - transaction

Returns:

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