Module org.refcodes.cli

Package org.refcodes.cli

Class CliSchema

java.lang.Object

java.util.AbstractMap<K,V>

java.util.HashMap<String,Object>

org.refcodes.schema.AbstractSchema

org.refcodes.cli.CliSchema

All Implemented Interfaces:

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

public class CliSchema
extends org.refcodes.schema.AbstractSchema
implements org.refcodes.mixin.DescriptionAccessor, org.refcodes.mixin.ValueAccessor<Object>

The purpose of a CliSchema is automatically generate documentation of Term 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

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 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	HAS_VALUE_KEY
static final String	MATCH_COUNT

Fields inherited from interface org.refcodes.schema.Schema

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

Constructor Summary

Constructors

Constructor	Description
CliSchema(Class<?> aType, String aDescription, Object aValue)	Instantiates a new CliSchema.
CliSchema(Class<?> aType, String aDescription, org.refcodes.schema.Schema... aChildren)	Instantiates a new CliSchema.
CliSchema(String aAlias, Class<?> aType, Object aValue, String aDescription, org.refcodes.schema.Schema... aChildren)	Instantiates a new CliSchema.
CliSchema(String aAlias, Class<?> aType, String aDescription, org.refcodes.schema.Schema... aChildren)	Instantiates a new CliSchema.

Method Summary

Modifier and Type	Method	Description
Object	getValue()

Methods inherited from class org.refcodes.schema.AbstractSchema

getChildren, 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.schema.Schema

getAlias, getDescription, getType, visit

Methods inherited from interface org.refcodes.mixin.ValueAccessor

getValueOr

Field Details

MATCH_COUNT

public static final String MATCH_COUNT

See Also:

• Constant Field Values

HAS_VALUE_KEY

public static final String HAS_VALUE_KEY

See Also:

• Constant Field Values

Constructor Details

CliSchema

public CliSchema(Class<?> aType,
 String aDescription,
 Object aValue)

Instantiates a new CliSchema.

Parameters:

aType - The type providing the this Schema instance.

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

aValue - The a value of the according element.

CliSchema

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

Instantiates a new CliSchema.

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.

CliSchema

public CliSchema(String aAlias,
 Class<?> aType,
 Object aValue,
 String aDescription,
 org.refcodes.schema.Schema... aChildren)

Instantiates a new CliSchema.

Parameters:

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

aType - The type providing the this Schema instance.

aValue - The a value of the according element.

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.

CliSchema

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

Instantiates a new CliSchema.

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.

Method Details

getValue

public Object getValue()

Specified by:

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