Package io.permazen

Class PermazenComplexField

java.lang.Object

io.permazen.PermazenSchemaItem

io.permazen.PermazenField

io.permazen.PermazenComplexField

Direct Known Subclasses:

PermazenCollectionField, PermazenMapField

public abstract class PermazenComplexField
extends PermazenField

Represents a complex field in a PermazenClass.

Method Summary

Modifier and Type	Method	Description
ComplexField<?>	getSchemaItem()	Get the corresonding core API database instance.
final PermazenSimpleField	getSubField(String name)	Get the sub-field with the given name.
abstract List<PermazenSimpleField>	getSubFields()	Get the sub-fields associated with this field.

Methods inherited from class io.permazen.PermazenField

getConverter, getDeclaringAnnotation, getFullName, getGetter, getKey, getPermazenClass, getTypeToken, getValue, 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

getSubFields

public abstract List<PermazenSimpleField> getSubFields()

Get the sub-fields associated with this field.

Returns:

this instance's sub-fields (in order)

getSubField

public final PermazenSimpleField getSubField(String name)

Get the sub-field with the given name.

Parameters:

name - sub-field name

Returns:

the sub-field with the specified name

Throws:

IllegalArgumentException - if name is invalid

getSchemaItem

public ComplexField<?> getSchemaItem()

Description copied from class: PermazenSchemaItem

Get the corresonding core API database instance.

Overrides:

getSchemaItem in class PermazenField

Returns:

this instance's correpsonding SchemaItem