Package io.permazen

Class PermazenCollectionField

java.lang.Object

io.permazen.PermazenSchemaItem

io.permazen.PermazenField

io.permazen.PermazenComplexField

io.permazen.PermazenCollectionField

Direct Known Subclasses:

PermazenListField, PermazenSetField

public abstract class PermazenCollectionField
extends PermazenComplexField

Represents a collection field in a PermazenClass.

Method Summary

Modifier and Type	Method	Description
PermazenSimpleField	getElementField()	Get the element sub-field.
CollectionField<?,?>	getSchemaItem()	Get the corresonding core API database instance.
List<PermazenSimpleField>	getSubFields()	Get the sub-fields associated with this field.
TypeToken<?>	getTypeToken()	Get the type of this field.
abstract Collection<?>	getValue(PermazenObject pobj)	Get the Java value of this field in the given Java model object.

Methods inherited from class io.permazen.PermazenComplexField

getSubField

Methods inherited from class io.permazen.PermazenField

getConverter, getDeclaringAnnotation, getFullName, getGetter, getKey, getPermazenClass, visit

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

getElementField

public PermazenSimpleField getElementField()

Get the element sub-field.

Returns:

this instance's element sub-field

getValue

public abstract Collection<?> 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 PermazenField

Parameters:

pobj - object containing this field

Returns:

this field's value in pobj

getSubFields

public List<PermazenSimpleField> getSubFields()

Description copied from class: PermazenComplexField

Get the sub-fields associated with this field.

Specified by:

getSubFields in class PermazenComplexField

Returns:

this instance's sub-fields (in order)

getSchemaItem

public CollectionField<?,?> getSchemaItem()

Description copied from class: PermazenSchemaItem

Get the corresonding core API database instance.

Overrides:

getSchemaItem in class PermazenComplexField

Returns:

this instance's correpsonding SchemaItem

getTypeToken

public TypeToken<?> getTypeToken()

Description copied from class: PermazenField

Get the type of this field.

Specified by:

getTypeToken in class PermazenField

Returns:

this field's type