Module org.refcodes.serial

Package org.refcodes.serial

Class SerialSchema

java.lang.Object

java.util.AbstractMap<String,Object>

java.util.HashMap<String,Object>

org.refcodes.schema.Schema

org.refcodes.serial.SerialSchema

All Implemented Interfaces:

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

public class SerialSchema
extends org.refcodes.schema.Schema
implements org.refcodes.mixin.LengthAccessor, org.refcodes.mixin.DescriptionAccessor, org.refcodes.mixin.ValueAccessor<Sequence>, org.refcodes.mixin.CommentAccessor

The purpose of a SerialSchema is to automatically outline and generate documentation of serial data (structures).

See Also:

• Serialized Form

Nested Class Summary

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

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

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,B extends org.refcodes.mixin.ChildrenAccessor.ChildrenBuilder<T,B>>, org.refcodes.mixin.ChildrenAccessor.ChildrenMutator<T>, org.refcodes.mixin.ChildrenAccessor.ChildrenProperty<T>

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

org.refcodes.mixin.CommentAccessor.CommentBuilder<B extends org.refcodes.mixin.CommentAccessor.CommentBuilder<B>>, org.refcodes.mixin.CommentAccessor.CommentMutator, org.refcodes.mixin.CommentAccessor.CommentProperty

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,V>

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

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

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

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

Field Summary

Fields

Modifier and Type	Field	Description
static final String	LENGTH

Fields inherited from class org.refcodes.schema.Schema

ALIAS, COMMENT, DESCRIPTION, EXCEPTION, KEY, TYPE, VALUE, VERBOSE

Constructor Summary

Constructors

Constructor	Description
SerialSchema(Class<?> aType, String aDescription, org.refcodes.schema.Schema... aChildren)
SerialSchema(Class<?> aType, Sequence aValue, int aLength, String aDescription, org.refcodes.schema.Schema... aChildren)	Constructs a SerialSchema with the provided arguments.
SerialSchema(Class<?> aType, Sequence aValue, String aVerbose, String aDescription, int aLength)	Constructs a SerialSchema with the provided arguments.
SerialSchema(String aAlias, Class<?> aType, String aDescription, int aLength)
SerialSchema(String aAlias, Class<?> aType, Sequence aValue, int aLength, String aVerbose, String aDescription, org.refcodes.schema.Schema... aChildren)	Constructs a SerialSchema with the provided arguments.
SerialSchema(String aAlias, Class<?> aType, Sequence aValue, int aLength, String aDescription, org.refcodes.schema.Schema... aChildren)	Constructs a SerialSchema with the provided arguments.

Method Summary

Modifier and Type	Method	Description
String	getComment()	Retrieves the verbose representation of the value.
int	getLength()
Sequence	getValue()

Methods inherited from class org.refcodes.schema.Schema

getAlias, getChildren, getDescription, getType, toString, visit

Methods inherited from class java.util.HashMap

clear, clone, compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, entrySet, forEach, get, getOrDefault, isEmpty, keySet, merge, newHashMap, 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 org.refcodes.mixin.DescriptionAccessor

getDescription

Methods inherited from interface java.util.Map

equals, hashCode

Methods inherited from interface org.refcodes.mixin.ValueAccessor

getValueOr

Field Details

LENGTH

public static final String LENGTH

See Also:

• Constant Field Values

Constructor Details

SerialSchema

public SerialSchema(Class<?> aType,
 String aDescription,
 org.refcodes.schema.Schema... aChildren)

SerialSchema

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

SerialSchema

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

Constructs a SerialSchema with the provided arguments.

Parameters:

aType - The type providing the this SerialSchema instance.

aValue - The content of the SerialSchema providing type.

aVerbose - The verbose representation of the value.

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

aLength - The length of the SerialSchema providing type.

SerialSchema

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

Constructs a SerialSchema with the provided arguments.

Parameters:

aType - The type providing the this SerialSchema instance.

aValue - The content of the SerialSchema providing type.

aLength - The length of the SerialSchema providing type.

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(String aAlias,
 Class<?> aType,
 Sequence aValue,
 int aLength,
 String aDescription,
 org.refcodes.schema.Schema... aChildren)

Constructs a SerialSchema with the provided arguments.

Parameters:

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

aType - The type providing the this SerialSchema instance.

aValue - The content of the SerialSchema providing type.

aLength - The length of the SerialSchema providing type.

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(String aAlias,
 Class<?> aType,
 Sequence aValue,
 int aLength,
 String aVerbose,
 String aDescription,
 org.refcodes.schema.Schema... aChildren)

Constructs a SerialSchema with the provided arguments.

Parameters:

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

aType - The type providing the this SerialSchema instance.

aValue - The content of the SerialSchema providing type.

aLength - The length of the SerialSchema providing type.

aVerbose - The verbose representation of the value.

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.

Method Details

getLength

public int getLength()

Specified by:

getLength in interface org.refcodes.mixin.LengthAccessor

getValue

public Sequence getValue()

Specified by:

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

getComment

public String getComment()

Retrieves the verbose representation of the value.

Specified by:

getComment in interface org.refcodes.mixin.CommentAccessor

Returns:

The human readable value representation.