Module org.refcodes.decoupling

Package org.refcodes.decoupling

Class DependencySchema

java.lang.Object

java.util.AbstractMap<String,Object>

java.util.HashMap<String,Object>

org.refcodes.schema.Schema

org.refcodes.decoupling.DependencySchema

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.SizeAccessor, org.refcodes.mixin.TypeAccessor

public class DependencySchema
extends org.refcodes.schema.Schema
implements org.refcodes.mixin.CommentAccessor, org.refcodes.mixin.SizeAccessor

The purpose of a DependencySchema is to automatically outline and generate documentation of Dependency configuration.

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 java.util.Map

Map.Entry<K,V>

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

org.refcodes.mixin.SizeAccessor.SizeBuilder<B extends org.refcodes.mixin.SizeAccessor.SizeBuilder<B>>, org.refcodes.mixin.SizeAccessor.SizeMutator, org.refcodes.mixin.SizeAccessor.SizeProperty

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>

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEPENDENCY
static final String	FACTORY
static final String	INSTANCES
static final String	MANDATORY
static final String	PROFILES
static final String	SETUP
static final String	SINGLETON
static final String	SIZE
static final String	TAGS

Fields inherited from class org.refcodes.schema.Schema

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

Constructor Summary

Constructors

Constructor	Description
DependencySchema(Class<?> aType, String aDescription, org.refcodes.schema.Schema... aChildren)
DependencySchema(String aAlias, Class<?> aType, String aDescription)
DependencySchema(String aAlias, Class<?> aType, String aDescription, org.refcodes.schema.Schema... aChildren)
DependencySchema(Claim aClaim)	Constructs a DependencySchema from the provided Claim.
DependencySchema(Dependency<?> aDependency, org.refcodes.schema.Schema... aChildren)	Constructs a DependencySchema from the provided Dependency and the provided arguments.
DependencySchema(FactoryClaim<?,?> aFactoryClaim)	Constructs a DependencySchema from the provided FactoryClaim.
DependencySchema(InitializerClaim<?,?> aInitializerClaim)	Constructs a DependencySchema from the provided InitializerClaim.

Method Summary

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

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 java.util.Map

equals, hashCode

Field Details

DEPENDENCY

public static final String DEPENDENCY

See Also:

• Constant Field Values

FACTORY

public static final String FACTORY

See Also:

• Constant Field Values

INSTANCES

public static final String INSTANCES

See Also:

• Constant Field Values

MANDATORY

public static final String MANDATORY

See Also:

• Constant Field Values

PROFILES

public static final String PROFILES

See Also:

• Constant Field Values

SETUP

public static final String SETUP

See Also:

• Constant Field Values

SINGLETON

public static final String SINGLETON

See Also:

• Constant Field Values

SIZE

public static final String SIZE

See Also:

• Constant Field Values

TAGS

public static final String TAGS

See Also:

• Constant Field Values

Constructor Details

DependencySchema

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

DependencySchema

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

DependencySchema

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

DependencySchema

public DependencySchema(Claim aClaim)

Constructs a DependencySchema from the provided Claim.

Parameters:

aClaim - The Claim from which to construct the schema.

DependencySchema

public DependencySchema(FactoryClaim<?,?> aFactoryClaim)

Constructs a DependencySchema from the provided FactoryClaim.

Parameters:

aFactoryClaim - The FactoryClaim from which to construct the schema.

DependencySchema

public DependencySchema(InitializerClaim<?,?> aInitializerClaim)

Constructs a DependencySchema from the provided InitializerClaim.

Parameters:

aInitializerClaim - The InitializerClaim from which to construct the schema.

DependencySchema

public DependencySchema(Dependency<?> aDependency,
 org.refcodes.schema.Schema... aChildren)

Constructs a DependencySchema from the provided Dependency and the provided arguments.

Parameters:

aDependency - The Dependency from which to retrieve the meta data of the schema.

aChildren - The children's DependencySchema descriptions representing part of the DependencySchema providing type.

Method Details

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.

getSize

public int getSize()

Specified by:

getSize in interface org.refcodes.mixin.SizeAccessor