Module org.refcodes.serial

Package org.refcodes.serial

Class Schema

java.lang.Object

java.util.AbstractMap<K,V>

java.util.HashMap<String,Object>

org.refcodes.serial.Schema

All Implemented Interfaces:

Serializable, Cloneable, Map<String,Object>, org.refcodes.mixin.AliasAccessor, org.refcodes.mixin.ChildrenAccessor<Schema[]>, org.refcodes.mixin.DescriptionAccessor, org.refcodes.mixin.LengthAccessor, org.refcodes.mixin.TypeAccessor, org.refcodes.mixin.ValueAccessor<Sequence>

public class Schema
extends HashMap<String,Object>
implements Map<String,Object>, org.refcodes.mixin.ChildrenAccessor<Schema[]>, org.refcodes.mixin.TypeAccessor, org.refcodes.mixin.AliasAccessor, org.refcodes.mixin.LengthAccessor, org.refcodes.mixin.DescriptionAccessor, org.refcodes.mixin.ValueAccessor<Sequence>

The purpose of a Schema is automatically generate documentation of serial data. It describes a portion of defined data such as a AllocSectionDecoratorSegment and its components such as Segment or Section. A type supporting its schema representation

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

org.refcodes.mixin.AliasAccessor.AliasBuilder<B extends org.refcodes.mixin.AliasAccessor.AliasBuilder<B>>, org.refcodes.mixin.AliasAccessor.AliasMutator, org.refcodes.mixin.AliasAccessor.AliasProperty

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

org.refcodes.mixin.ChildrenAccessor.ChildrenBuilder<T extends Object,B extends org.refcodes.mixin.ChildrenAccessor.ChildrenBuilder<T,B>>, org.refcodes.mixin.ChildrenAccessor.ChildrenMutator<T extends Object>, org.refcodes.mixin.ChildrenAccessor.ChildrenProperty<T extends Object>

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

org.refcodes.mixin.DescriptionAccessor.DescriptionBuilder<B extends org.refcodes.mixin.DescriptionAccessor.DescriptionBuilder<B>>, org.refcodes.mixin.DescriptionAccessor.DescriptionMutator, org.refcodes.mixin.DescriptionAccessor.DescriptionProperty

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

org.refcodes.mixin.LengthAccessor.LengthBuilder<B extends org.refcodes.mixin.LengthAccessor.LengthBuilder<B>>, org.refcodes.mixin.LengthAccessor.LengthMutator, org.refcodes.mixin.LengthAccessor.LengthProperty

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

org.refcodes.mixin.TypeAccessor.TypeBuilder<T extends Object,B extends org.refcodes.mixin.TypeAccessor.TypeBuilder<T,B>>, org.refcodes.mixin.TypeAccessor.TypeMutator<T extends Object>, org.refcodes.mixin.TypeAccessor.TypeProperty<T extends Object>

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

org.refcodes.mixin.ValueAccessor.ValueBuilder<V extends Object,B extends org.refcodes.mixin.ValueAccessor.ValueBuilder<V,B>>, org.refcodes.mixin.ValueAccessor.ValueMutator<V extends Object>, org.refcodes.mixin.ValueAccessor.ValueProperty<V extends Object>

Field Summary

Fields

Modifier and Type	Field	Description
static String	ALIAS
static String	DESCRIPTION
static String	LENGTH
static String	TYPE
static String	VALUE
static String	VERBOSE

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
String	getAlias()
Schema[]	getChildren()
String	getDescription()
int	getLength()
Class<?>	getType()
Sequence	getValue()
String	getVerboseValue()	Retrieves the verbose representation of the value.
String	toString()

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.ValueAccessor

getValueOr

Field Detail

VERBOSE

public static final String VERBOSE

See Also:

Constant Field Values

LENGTH

public static final String LENGTH

See Also:

Constant Field Values

VALUE

public static final String VALUE

See Also:

Constant Field Values

TYPE

public static final String TYPE

See Also:

Constant Field Values

DESCRIPTION

public static final String DESCRIPTION

See Also:

Constant Field Values

ALIAS

public static final String ALIAS

See Also:

Constant Field Values

Constructor Detail

Schema

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

Constructs a Schema with the provided arguments.

Parameters:

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

aType - The type providing the this Schema instance.

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

Schema

public Schema(Sequence aValue,
              int aLength,
              String aDescription,
              Class<?> aType)

Constructs a Schema with the provided arguments.

Parameters:

aValue - The content of the Schema providing type.

aLength - The length of the Schema providing type.

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

aType - The type providing the this Schema instance.

Schema

public Schema(Sequence aValue,
              String aVerbose,
              int aLength,
              String aDescription,
              Class<?> aType)

Constructs a Schema with the provided arguments.

Parameters:

aValue - The content of the Schema providing type.

aVerbose - The verbose representation of the value.

aLength - The length of the Schema providing type.

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

aType - The type providing the this Schema instance.

Schema

public Schema(Sequence aValue,
              int aLength,
              String aDescription,
              Class<?> aType,
              Schema... aChildren)

Constructs a Schema with the provided arguments.

Parameters:

aValue - The content of the Schema providing type.

aLength - The length of the Schema providing type.

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

aType - The type providing the this Schema instance.

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

Schema

public Schema(Sequence aValue,
              String aVerbose,
              int aLength,
              String aDescription,
              Class<?> aType,
              Schema... aChildren)

Constructs a Schema with the provided arguments.

Parameters:

aValue - The content of the Schema providing type.

aVerbose - The verbose representation of the value.

aLength - The length of the Schema providing type.

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

aType - The type providing the this Schema instance.

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

Schema

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

Constructs a Schema with the provided arguments.

Parameters:

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

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

aType - The type providing the this Schema instance.

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

Schema

public Schema(String aAlias,
              int aLength,
              String aDescription,
              Class<?> aType)

Constructs a Schema with the provided arguments.

Parameters:

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

aLength - The length of the Schema providing type.

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

aType - The type providing the this Schema instance.

Schema

public Schema(String aAlias,
              Sequence aValue,
              int aLength,
              String aDescription,
              Class<?> aType)

Constructs a Schema with the provided arguments.

Parameters:

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

aValue - The content of the Schema providing type.

aLength - The length of the Schema providing type.

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

aType - The type providing the this Schema instance.

Schema

public Schema(String aAlias,
              Sequence aValue,
              String aVerbose,
              int aLength,
              String aDescription,
              Class<?> aType)

Constructs a Schema with the provided arguments.

Parameters:

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

aValue - The content of the Schema providing type.

aVerbose - The verbose representation of the value.

aLength - The length of the Schema providing type.

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

aType - The type providing the this Schema instance.

Schema

public Schema(String aAlias,
              Sequence aValue,
              int aLength,
              String aDescription,
              Class<?> aType,
              Schema... aChildren)

Constructs a Schema with the provided arguments.

Parameters:

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

aValue - The content of the Schema providing type.

aLength - The length of the Schema providing type.

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

aType - The type providing the this Schema instance.

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

Schema

public Schema(String aAlias,
              Sequence aValue,
              String aVerbose,
              int aLength,
              String aDescription,
              Class<?> aType,
              Schema... aChildren)

Constructs a Schema with the provided arguments.

Parameters:

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

aValue - The content of the Schema providing type.

aVerbose - The verbose representation of the value.

aLength - The length of the Schema providing type.

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

aType - The type providing the this Schema instance.

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

Schema

public Schema(Schema aSchema)

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

Parameters:

aSchema - The Schema from which to copy the attributes.

Schema

public Schema(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 Detail

getValue

public Sequence getValue()

Specified by:

getValue in interface org.refcodes.mixin.ValueAccessor<Sequence>

getVerboseValue

public String getVerboseValue()

Retrieves the verbose representation of the value.

Returns:

The human readable value representation.

getDescription

public String getDescription()

Specified by:

getDescription in interface org.refcodes.mixin.DescriptionAccessor

getLength

public int getLength()

Specified by:

getLength in interface org.refcodes.mixin.LengthAccessor

getAlias

public String getAlias()

Specified by:

getAlias in interface org.refcodes.mixin.AliasAccessor

getType

public Class<?> getType()

Specified by:

getType in interface org.refcodes.mixin.TypeAccessor

getChildren

public Schema[] getChildren()

Specified by:

getChildren in interface org.refcodes.mixin.ChildrenAccessor<Schema[]>

toString

public String toString()

Overrides:

toString in class AbstractMap<String,Object>