- All Implemented Interfaces:
Serializable
,Cloneable
,Map<String,
,Object> org.refcodes.mixin.AliasAccessor
,org.refcodes.mixin.ChildrenAccessor<org.refcodes.mixin.Schema[]>
,org.refcodes.mixin.DescriptionAccessor
,org.refcodes.mixin.Schema
,org.refcodes.mixin.TypeAccessor
,org.refcodes.mixin.ValueAccessor<Object>
public class CliSchema
extends org.refcodes.mixin.AbstractSchema
implements org.refcodes.mixin.DescriptionAccessor, org.refcodes.mixin.ValueAccessor<Object>
The purpose of a
CliSchema
is automatically generate documentation of
Constituent
structures.- See Also:
-
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
ConstructorDescriptionInstantiates a newCliSchema
.CliSchema
(String aAlias, Class<?> aType, Object aValue, String aDescription, org.refcodes.mixin.Schema... aChildren) Instantiates a newCliSchema
.CliSchema
(String aAlias, Class<?> aType, String aDescription, org.refcodes.mixin.Schema... aChildren) Instantiates a newCliSchema
. -
Method Summary
Methods inherited from class org.refcodes.mixin.AbstractSchema
getChildren, 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.Schema
getAlias, getDescription, getType
Methods inherited from interface org.refcodes.mixin.ValueAccessor
getValueOr
-
Constructor Details
-
CliSchema
Instantiates a newCliSchema
.- Parameters:
aType
- The type providing the thisSchema
instance.aDescription
- The description of the schema described by theSchema
providing type.aValue
- The a value of the according element.
-
CliSchema
public CliSchema(String aAlias, Class<?> aType, String aDescription, org.refcodes.mixin.Schema... aChildren) Instantiates a newCliSchema
.- Parameters:
aAlias
- The alias (name) of the schema described by theSchema
providing type.aType
- The type providing the thisSchema
instance.aDescription
- The description of the schema described by theSchema
providing type.aChildren
- The children'sSchema
descriptions representing part of theSchema
providing type.
-
CliSchema
public CliSchema(String aAlias, Class<?> aType, Object aValue, String aDescription, org.refcodes.mixin.Schema... aChildren) Instantiates a newCliSchema
.- Parameters:
aAlias
- The alias (name) of the schema described by theSchema
providing type.aType
- The type providing the thisSchema
instance.aValue
- The a value of the according element.aDescription
- The description of the schema described by theSchema
providing type.aChildren
- The children'sSchema
descriptions representing part of theSchema
providing type.
-
-
Method Details
-
getValue
- Specified by:
getValue
in interfaceorg.refcodes.mixin.ValueAccessor<Object>
-