Module org.refcodes.mixin

Package org.refcodes.mixin

Class AbstractSchema

java.lang.Object

java.util.AbstractMap<K,V>

java.util.HashMap<String,Object>

org.refcodes.mixin.AbstractSchema

All Implemented Interfaces:

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

public abstract class AbstractSchema
extends HashMap<String,Object>
implements Schema

The purpose of a Schema is automatically generate documentation of nested data structures.

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K extends Object,V extends Object>, AbstractMap.SimpleImmutableEntry<K extends Object,V extends Object>

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 inherited from interface org.refcodes.mixin.Schema

ALIAS, DESCRIPTION, EXCEPTION, KEY, TYPE, VALUE

Constructor Summary

Constructors

Constructor	Description
AbstractSchema(Class<?> aType, String aDescription)	Constructs a Schema with the provided arguments.
AbstractSchema(Class<?> aType, String aDescription, Schema... aChildren)	Constructs a Schema with the provided arguments.
AbstractSchema(Class<?> aType, Schema aSchema)	Constructs a Schema with the provided arguments.
AbstractSchema(String aAlias, Class<?> aType)	Constructs a Schema with the provided arguments.
AbstractSchema(String aAlias, Class<?> aType, String aDescription)	Constructs a Schema with the provided arguments.
AbstractSchema(String aAlias, Class<?> aType, String aDescription, Schema... aChildren)	Constructs a Schema with the provided arguments.
AbstractSchema(Schema aSchema)	Constructs a Schema with the properties of the provided Schema ("copy constructor"),.
AbstractSchema(Schema aSchema, Schema... aChildren)	Constructs a Schema with the properties of the provided Schema ("copy constructor"),.

Method Summary

Modifier and Type	Method	Description
Schema[]	getChildren()	Retrieves the children from the children property.
String	toString()
protected String	toString(Object aValue)	Hook method for converting a type to an according String.

Methods inherited from class java.util.HashMap

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

Methods inherited from class java.util.AbstractMap

equals, hashCode

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

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

Methods inherited from interface org.refcodes.mixin.Schema

getAlias, getDescription, getType

Constructor Details

AbstractSchema

public AbstractSchema(Class<?> aType,
 String aDescription)

Constructs a Schema with the provided arguments.

Parameters:

aType - The type providing the this Schema instance.

aDescription - The description of the schema described by the Schema providing type.

AbstractSchema

public AbstractSchema(String aAlias,
 Class<?> aType)

Constructs a Schema with the provided arguments.

Parameters:

aAlias - The alias (name) of the schema described by the Schema providing type.

aType - The type providing the this Schema instance.

AbstractSchema

public AbstractSchema(String aAlias,
 Class<?> aType,
 String aDescription)

Constructs a Schema with the provided arguments.

Parameters:

aAlias - The alias (name) of the schema described by the Schema providing type.

aType - The type providing the this Schema instance.

aDescription - The description of the schema described by the Schema providing type.

AbstractSchema

public AbstractSchema(Class<?> aType,
 String aDescription,
 Schema... aChildren)

Constructs a Schema with the provided arguments.

Parameters:

aType - The type providing the this Schema instance.

aDescription - The description of the schema described by the Schema providing type.

aChildren - The children's Schema descriptions representing part of the Schema providing type.

AbstractSchema

public AbstractSchema(String aAlias,
 Class<?> aType,
 String aDescription,
 Schema... aChildren)

Constructs a Schema with the provided arguments.

Parameters:

aAlias - The alias (name) of the schema described by the Schema providing type.

aType - The type providing the this Schema instance.

aDescription - The description of the schema described by the Schema providing type.

aChildren - The children's Schema descriptions representing part of the Schema providing type.

AbstractSchema

public AbstractSchema(Schema aSchema)

Constructs a Schema with the properties of the provided Schema ("copy constructor"),.

Parameters:

aSchema - The Schema from which to copy the attributes.

AbstractSchema

public AbstractSchema(Class<?> aType,
 Schema aSchema)

Constructs a Schema with the provided arguments.

Parameters:

aType - The type providing the this Schema instance.

aSchema - The Schema from which to copy the attributes.

AbstractSchema

public AbstractSchema(Schema aSchema,
 Schema... aChildren)

Constructs a Schema with the properties of the provided Schema ("copy constructor"),.

Parameters:

aSchema - The Schema from which to copy the attributes.

aChildren - The children's Schema descriptions representing part of the Schema providing type.

Method Details

getChildren

public Schema[] getChildren()

Retrieves the children from the children property.

Specified by:

getChildren in interface ChildrenAccessor<Schema[]>

Specified by:

getChildren in interface Schema

Returns:

The children stored by the children property.

toString

public String toString()

Overrides:

toString in class AbstractMap<String,Object>

toString

protected String toString(Object aValue)

Hook method for converting a type to an according String.

Parameters:

aValue - The value of a given type to be converted accordingly.

Returns:

The accordingly converted value.