Module org.refcodes.mixin

Package org.refcodes.mixin

Interface Schema

All Superinterfaces:

AliasAccessor, ChildrenAccessor<Schema[]>, DescriptionAccessor, Map<String,Object>, TypeAccessor

All Known Implementing Classes:

AbstractSchema

public interface Schema
extends Map<String,Object>, ChildrenAccessor<Schema[]>, TypeAccessor, AliasAccessor, DescriptionAccessor

A Schema describes a nested data structure with 0..n children schemata whilst not being the data structure itself. For description purposes, any descriptive attribute can be added as a key with the according value, as a Schema extends the Map interface.

Nested Class Summary

Nested classes/interfaces inherited from interface org.refcodes.mixin.AliasAccessor

AliasAccessor.AliasBuilder<B extends AliasAccessor.AliasBuilder<B>>, AliasAccessor.AliasMutator, AliasAccessor.AliasProperty

Nested classes/interfaces inherited from interface org.refcodes.mixin.ChildrenAccessor

ChildrenAccessor.ChildrenBuilder<T,B extends ChildrenAccessor.ChildrenBuilder<T,B>>, ChildrenAccessor.ChildrenMutator<T>, ChildrenAccessor.ChildrenProperty<T>

Nested classes/interfaces inherited from interface org.refcodes.mixin.DescriptionAccessor

DescriptionAccessor.DescriptionBuilder<B extends DescriptionAccessor.DescriptionBuilder<B>>, DescriptionAccessor.DescriptionMutator, DescriptionAccessor.DescriptionProperty

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K extends Object,V extends Object>

Nested classes/interfaces inherited from interface org.refcodes.mixin.TypeAccessor

TypeAccessor.TypeBuilder<T,B extends TypeAccessor.TypeBuilder<T,B>>, TypeAccessor.TypeMutator<T>, TypeAccessor.TypeProperty<T>

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ALIAS
static final String	DESCRIPTION
static final String	KEY
static final String	TYPE
static final String	VALUE

Method Summary

Modifier and Type	Method	Description
default String	getAlias()	Retrieves the alias from the alias property.
Schema[]	getChildren()	Retrieves the children from the children property.
default String	getDescription()	Retrieves the description from the description property.
default Class<?>	getType()	Retrieves the type property.

Methods inherited from interface java.util.Map

clear, compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, entrySet, equals, forEach, get, getOrDefault, hashCode, isEmpty, keySet, merge, put, putAll, putIfAbsent, remove, remove, replace, replace, replaceAll, size, values

Field Details

DESCRIPTION

static final String DESCRIPTION

See Also:

• Constant Field Values

ALIAS

static final String ALIAS

See Also:

• Constant Field Values

TYPE

static final String TYPE

See Also:

• Constant Field Values

VALUE

static final String VALUE

See Also:

• Constant Field Values

KEY

static final String KEY

See Also:

• Constant Field Values

Method Details

getChildren

Schema[] getChildren()

Retrieves the children from the children property.

Specified by:

getChildren in interface ChildrenAccessor<Schema[]>

Returns:

The children stored by the children property.

getAlias

default String getAlias()

Retrieves the alias from the alias property.

Specified by:

getAlias in interface AliasAccessor

Returns:

The alias stored by the alias property.

getType

default Class<?> getType()

Retrieves the type property.

Specified by:

getType in interface TypeAccessor

Returns:

The type stored by the property.

getDescription

default String getDescription()

Retrieves the description from the description property.

Specified by:

getDescription in interface DescriptionAccessor

Returns:

The description stored by the description property.