Module org.refcodes.serial

Package org.refcodes.serial

Class SerialSchema

java.lang.Object

java.util.AbstractMap<K,V>

java.util.HashMap<String,Object>

org.refcodes.mixin.AbstractSchema<SerialSchema>

org.refcodes.serial.SerialSchema

All Implemented Interfaces:

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

public class SerialSchema
extends org.refcodes.mixin.AbstractSchema<SerialSchema>
implements org.refcodes.mixin.AliasAccessor, org.refcodes.mixin.LengthAccessor, org.refcodes.mixin.DescriptionAccessor, org.refcodes.mixin.ValueAccessor<Sequence>

The purpose of a SerialSchema 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 final String	LENGTH
static final String	VERBOSE

Fields inherited from interface org.refcodes.mixin.Schema

ALIAS, DESCRIPTION, KEY, TYPE, VALUE

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
String	getAlias()
String	getDescription()
int	getLength()
Sequence	getValue()
String	getVerbose()	Retrieves the verbose representation of the value.
protected String	toString(Object aValue)

Methods inherited from class org.refcodes.mixin.AbstractSchema

getChildren, getType, 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 Details

VERBOSE

public static final String VERBOSE

See Also:

• Constant Field Values

LENGTH

public static final String LENGTH

See Also:

• Constant Field Values

Constructor Details

SerialSchema

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

Constructs a SerialSchema with the provided arguments.

Parameters:

aType - The type providing the this SerialSchema instance.

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

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

SerialSchema

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

Constructs a SerialSchema with the provided arguments.

Parameters:

aType - The type providing the this SerialSchema instance.

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

aValue - The content of the SerialSchema providing type.

aLength - The length of the SerialSchema providing type.

SerialSchema

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

Constructs a SerialSchema with the provided arguments.

Parameters:

aType - The type providing the this SerialSchema instance.

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

aValue - The content of the SerialSchema providing type.

aVerbose - The verbose representation of the value.

aLength - The length of the SerialSchema providing type.

SerialSchema

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

Constructs a SerialSchema with the provided arguments.

Parameters:

aType - The type providing the this SerialSchema instance.

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

aValue - The content of the SerialSchema providing type.

aLength - The length of the SerialSchema providing type.

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

SerialSchema

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

Constructs a SerialSchema with the provided arguments.

Parameters:

aType - The type providing the this SerialSchema instance.

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

aValue - The content of the SerialSchema providing type.

aVerbose - The verbose representation of the value.

aLength - The length of the SerialSchema providing type.

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

SerialSchema

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

Constructs a SerialSchema with the provided arguments.

Parameters:

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

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

aType - The type providing the this SerialSchema instance.

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

SerialSchema

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

Constructs a SerialSchema with the provided arguments.

Parameters:

aType - The type providing the this SerialSchema instance.

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

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

aLength - The length of the SerialSchema providing type.

SerialSchema

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

Constructs a SerialSchema with the provided arguments.

Parameters:

aType - The type providing the this SerialSchema instance.

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

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

aValue - The content of the SerialSchema providing type.

aLength - The length of the SerialSchema providing type.

SerialSchema

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

Constructs a SerialSchema with the provided arguments.

Parameters:

aType - The type providing the this SerialSchema instance.

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

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

aValue - The content of the SerialSchema providing type.

aVerbose - The verbose representation of the value.

aLength - The length of the SerialSchema providing type.

SerialSchema

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

Constructs a SerialSchema with the provided arguments.

Parameters:

aType - The type providing the this SerialSchema instance.

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

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

aValue - The content of the SerialSchema providing type.

aLength - The length of the SerialSchema providing type.

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

SerialSchema

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

Constructs a SerialSchema with the provided arguments.

Parameters:

aType - The type providing the this SerialSchema instance.

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

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

aValue - The content of the SerialSchema providing type.

aVerbose - The verbose representation of the value.

aLength - The length of the SerialSchema providing type.

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

SerialSchema

public SerialSchema(SerialSchema aSchema)

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

Parameters:

aSchema - The SerialSchema from which to copy the attributes.

SerialSchema

public SerialSchema(SerialSchema aSchema,
 SerialSchema... aChildren)

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

Parameters:

aSchema - The SerialSchema from which to copy the attributes.

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

Method Details

getValue

public Sequence getValue()

Specified by:

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

getLength

public int getLength()

Specified by:

getLength in interface org.refcodes.mixin.LengthAccessor

getVerbose

public String getVerbose()

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

getAlias

public String getAlias()

Specified by:

getAlias in interface org.refcodes.mixin.AliasAccessor

toString

protected String toString(Object aValue)

Overrides:

toString in class org.refcodes.mixin.AbstractSchema<SerialSchema>