Class CliSchema

java.lang.Object

java.util.AbstractMap<String,Object>

java.util.HashMap<String,Object>

org.refcodes.schema.Schema

org.refcodes.cli.CliSchema

All Implemented Interfaces:

Serializable, Cloneable, Map<String,Object>, org.refcodes.exception.ExceptionAccessor<Throwable>, org.refcodes.mixin.AliasAccessor, org.refcodes.mixin.ChildrenAccessor<org.refcodes.schema.Schema[]>, org.refcodes.mixin.DescriptionAccessor, org.refcodes.mixin.HashAccessor, org.refcodes.mixin.IdentifierAccessor, org.refcodes.mixin.KeyAccessor<String>, org.refcodes.mixin.StereotypeAccessor<String>, org.refcodes.mixin.TypeAccessor, org.refcodes.mixin.ValueAccessor<Object>

public class CliSchema
extends org.refcodes.schema.Schema

The purpose of a CliSchema is automatically generate documentation of Term structures.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	CliSchema.Builder	CliSchema.Builder to build CliSchema.

Nested classes/interfaces inherited from class 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>, 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>, org.refcodes.mixin.ChildrenAccessor.ChildrenMutator<T>, org.refcodes.mixin.ChildrenAccessor.ChildrenProperty<T>

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

org.refcodes.mixin.DescriptionAccessor.DescriptionBuilder<B>, org.refcodes.mixin.DescriptionAccessor.DescriptionMutator, org.refcodes.mixin.DescriptionAccessor.DescriptionProperty

Nested classes/interfaces inherited from interface org.refcodes.exception.ExceptionAccessor

org.refcodes.exception.ExceptionAccessor.ExceptionBuilder<EXC,B>, org.refcodes.exception.ExceptionAccessor.ExceptionMutator<EXC>, org.refcodes.exception.ExceptionAccessor.ExceptionProperty<EXC>

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

org.refcodes.mixin.HashAccessor.HashBuilder<B>, org.refcodes.mixin.HashAccessor.HashMutator, org.refcodes.mixin.HashAccessor.HashProperty

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

org.refcodes.mixin.IdentifierAccessor.IdentifierBuilder<B>, org.refcodes.mixin.IdentifierAccessor.IdentifierMutator, org.refcodes.mixin.IdentifierAccessor.IdentifierProperty

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

org.refcodes.mixin.KeyAccessor.KeyBuilder<K,B>, org.refcodes.mixin.KeyAccessor.KeyMutator<K>, org.refcodes.mixin.KeyAccessor.KeyProperty<K>

Nested classes/interfaces inherited from interface Map

Map.Entry<K,V>

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

org.refcodes.mixin.StereotypeAccessor.StereotypeBuilder<T,B>, org.refcodes.mixin.StereotypeAccessor.StereotypeMutator<T>, org.refcodes.mixin.StereotypeAccessor.StereotypeProperty<T>

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

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>, org.refcodes.mixin.ValueAccessor.ValueMutator<V>, org.refcodes.mixin.ValueAccessor.ValueProperty<V>

Field Summary

Fields

Modifier and Type	Field	Description
static final String	HAS_VALUE_KEY
static final String	MATCH_COUNT

Fields inherited from class org.refcodes.schema.Schema

_children, ALIAS, ASSOCIATION, DESCRIPTION, EXCEPTION, HASH, HASH_SEPARATOR, IDENTIFIER, KEY, STEREOTYPE, TYPE, VALUE

Constructor Summary

Constructors

Constructor	Description
CliSchema(String aIdentifier, String aAlias, String aKey, Class<?> aType, Integer aHash, String aStereotype, Object aValue, Throwable aException, String aDescription, org.refcodes.schema.Schema aSchema, org.refcodes.schema.Schema[] aChildren)	Constructs a CliSchema with the provided arguments.

Method Summary

Modifier and Type	Method	Description
static CliSchema.Builder	builder()	Creates builder to build CliSchema.

Methods inherited from class org.refcodes.schema.Schema

getAlias, getChildren, getDescription, getException, getHash, getIdentifier, getKey, getStereotype, getType, getValue, init, toLabel, toNotation, toObjectId, toSimpleObjectId, toString, visit

Methods inherited from class 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 AbstractMap

equals, hashCode

Methods inherited from class Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface Map

equals, hashCode

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(String aIdentifier,
 String aAlias,
 String aKey,
 Class<?> aType,
 Integer aHash,
 String aStereotype,
 Object aValue,
 Throwable aException,
 String aDescription,
 org.refcodes.schema.Schema aSchema,
 org.refcodes.schema.Schema[] aChildren)

Constructs a CliSchema with the provided arguments.

Parameters:

aIdentifier - The identifier being the label for the Schema, when null the alias, the key or the type's simple name prefixed with the @ character alongside the hash (or this instance's identity has code when null).

aAlias - The alias (name) describing this Schema, when null, then the alias is extrapolated from the identifier's portion till the last @ character (if any).

aKey - The key (of a value) provided with this Schema

aType - The type described by this Schema.

aHash - The hash if the instance described by this Schema.

aStereotype - The stereotype related with this Schema.

aValue - The value representing this Schema.

aException - The Throwable related with this Schema.

aDescription - The description for this Schema.

aSchema - The Schema from which to copy from (in case of not being explicitly set by the arguments).

aChildren - The Schema's children (aggregation structure).

Method Details

builder

public static CliSchema.Builder builder()

Creates builder to build CliSchema.

Returns:

created builder