Class CliSchema

java.lang.Object
java.util.AbstractMap<K,V>
java.util.HashMap<String,Object>
org.refcodes.mixin.AbstractSchema
org.refcodes.cli.CliSchema
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:
  • 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(String aAlias, Class<?> aType, String aDescription, org.refcodes.mixin.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.
    • CliSchema

      public CliSchema(String aAlias, Class<?> aType, Object aValue, String aDescription, org.refcodes.mixin.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.
  • Method Details

    • getValue

      public Object getValue()
      Specified by:
      getValue in interface org.refcodes.mixin.ValueAccessor<Object>