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.mixin.AbstractSchema<CliSchema>

org.refcodes.cli.CliSchema

All Implemented Interfaces:

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

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

The purpose of a CliSchema is automatically generate documentation of Constituent 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 inherited from interface org.refcodes.mixin.Schema

ALIAS, DESCRIPTION, KEY, TYPE, VALUE

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
String	getAlias()
String	getDescription()
Object	getValue()

Methods inherited from class org.refcodes.mixin.AbstractSchema

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

Constructor Details

CliSchema

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

CliSchema

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

CliSchema

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

CliSchema

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

CliSchema

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

Instantiates a new CliSchema.

Parameters:

aType - the a type

aDescription - the a description

aValue - the a value

aChildren - the a children

CliSchema

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

Instantiates a new CliSchema.

Parameters:

aType - the a type

aAlias - the a alias

aDescription - the a description

aValue - the a value

aChildren - the a children

CliSchema

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

Instantiates a new CliSchema.

Parameters:

aType - the a type

aAlias - the a alias

aDescription - the a description

aValue - the a value

CliSchema

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

Instantiates a new CliSchema.

Parameters:

aType - the a type

aDescription - the a description

aValue - the a value

CliSchema

public CliSchema(CliSchema aSchema,
 CliSchema... aChildren)

CliSchema

public CliSchema(CliSchema aSchema)

Method Details

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

getValue

public Object getValue()

Specified by:

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