Package org.refcodes.structure

This artifact contains base definitions regarding collections being used throughout the `REFCODES.ORG` artifacts; to unify management of various kinds of collections.

Please note the PathMap, which's extension, the HttpBodyMap (found in the refcodes-net artifact) is used to represent dynamic data types produced e.g. by JavaScript clients.

Interface Summary

Interface	Description
Attribute	Interface describing a bean's attribute with a key represented by a String and the value being of any type.
Attribute.AttributeBuilder	Adds builder functionality to an Attribute.
BooleanArrayAccessor	Provides an accessor for a boolean array property.
BooleanArrayAccessor.BooleanArrayBuilder<B extends BooleanArrayAccessor.BooleanArrayBuilder<B>>	Provides a builder method for a boolean array property returning the builder for applying multiple build operations.
BooleanArrayAccessor.BooleanArrayMutator	Provides a mutator for a boolean array property.
BooleanArrayAccessor.BooleanArrayProperty	Provides a boolean array property.
ByteArrayAccessor	Provides an accessor for a byte array property.
ByteArrayAccessor.ByteArrayBuilder<B extends ByteArrayAccessor.ByteArrayBuilder<B>>	Provides a builder method for a byte array property returning the builder for applying multiple build operations.
ByteArrayAccessor.ByteArrayMutator	Provides a mutator for a byte array property.
ByteArrayAccessor.ByteArrayProperty	Provides a byte array property.
CanonicalMap	The CanonicalMap is an "intermediate" type adding type and Data-Structure related functionality to any implementing class.
CanonicalMap.CanonicalMapBuilder	The Interface CanonicalMapBuilder.
CanonicalMap.MutableCanonicalMap	The Interface MutableCanonicalMap.
Clearable	Provides a mixin to clear a collection from all its contained elements.
Containable	A Containable is the base functionality provided container (collection).
Container<E>	Basic functionality being provided by any Container (collection) style class.
Container.ClearableContainer<E>	Extends the Container interface with Clearable functionality (as of Clearable.clear()).
Container.MutableContainer<E>	Extends the Container with mutable (writable) functionality, especially by enabling the Iterator.remove() method in the Iterator provided via Elements.iterator().
Dictionary<K,V>	Basic functionality being provided by any Dictionary (map) style class.
Dictionary.MutableDictionary<K,V>	Extends the Dictionary with mutable (writable) functionality, especially by providing Keys.MutableValues.put(Object, Object) and Keys.MutableKeys.delete(String) methods.
Dictionary.MutableDictionary.DictionaryBuilder<K,V,B extends Dictionary.MutableDictionary.DictionaryBuilder<K,V,B>>	Provides a builder method for a Relation property returning the builder for applying multiple build operations.
DoubleArrayAccessor	Provides an accessor for a double array property.
DoubleArrayAccessor.DoubleArrayBuilder<B extends DoubleArrayAccessor.DoubleArrayBuilder<B>>	Provides a builder method for a double array property returning the builder for applying multiple build operations.
DoubleArrayAccessor.DoubleArrayMutator	Provides a mutator for a double array property.
DoubleArrayAccessor.DoubleArrayProperty	Provides a double array property.
Elements<E>	Basic functionality being provided by any Elements (collection) style class.
Elements.ClearableElements<E>	Extends the Elements interface with Clearable functionality (as of Clearable.clear()).
Elements.MutableElements<E>	Extends the Elements with mutable (writable) functionality, especially by enabling the Iterator.remove() method in the Iterator provided via Elements.MutableElements.iterator() and by providing the Elements.MutableElements.add(Object) and the Elements.MutableElements.remove(Object) methods.
FloatArrayAccessor	Provides an accessor for a float array property.
FloatArrayAccessor.FloatArrayBuilder<B extends FloatArrayAccessor.FloatArrayBuilder<B>>	Provides a builder method for a float array property returning the builder for applying multiple build operations.
FloatArrayAccessor.FloatArrayMutator	Provides a mutator for a float array property.
FloatArrayAccessor.FloatArrayProperty	Provides a float array property.
Keys<K,V>	This interface provides functionality for working with keys.
Keys.MutableKeys<K,V>	Adds mutable functionality to the Keys interface.
Keys.MutableValues<K,V>	Mixin for mutable functionality accompanying the Keys interface.
LongArrayAccessor	Provides an accessor for a long array property.
LongArrayAccessor.LongArrayBuilder<B extends LongArrayAccessor.LongArrayBuilder<B>>	Provides a builder method for a long array property returning the builder for applying multiple build operations.
LongArrayAccessor.LongArrayMutator	Provides a mutator for a long array property.
LongArrayAccessor.LongArrayProperty	Provides a long array property.
PathMap<T>	A PathMap is a flat map by which each element is addressed by a path; represented by the PathMap's keys.
PathMap.MutablePathMap<T>	The PathMap.MutablePathMap adds mutable functionality to the PathMap.
PathMap.PathMapBuilder<T>	The PathMap.PathMapBuilder adds builder functionality to the PathMap.MutablePathMap.
PropertiesAccessorMixin	Mixin with lots of accessor default methods for String key/value Map or Dictionary implementations.
PropertiesAccessorMixin.PropertiesBuilderMixin<T>	Mixin with lots of builder default methods for String key/value Map or Dictionary implementations.
PropertiesAccessorMixin.PropertiesMixin	Mixin with lots of accessing and mutating default methods for String key/value Map or Dictionary implementations.
PropertiesAccessorMixin.PropertiesMutatorMixin	Mixin with lots of mutating default methods for String key/value Map or Dictionary implementations.
Property	A Property is defined as being String representing a property's key and a String representing the proprty's value.
Property.PropertyBuilder	Adds builder functionality to a Property.
Range<V extends java.lang.Number & java.lang.Comparable<V>>	Interface describing a range with a minimum value and a maximum value.
Range.RangeBuilder<V extends java.lang.Number & java.lang.Comparable<V>>	Adds builder functionality to a Range.
Relation<K,V>	Provides an accessor for a key-to-value property useful in some occasions.
Relation.RelationBuilder<K,V>	Adds builder functionality to a Relation.
ShortArrayAccessor	Provides an accessor for a short array property.
ShortArrayAccessor.ShortArrayBuilder<B extends ShortArrayAccessor.ShortArrayBuilder<B>>	Provides a builder method for a short array property returning the builder for applying multiple build operations.
ShortArrayAccessor.ShortArrayMutator	Provides a mutator for a short array property.
ShortArrayAccessor.ShortArrayProperty	Provides a short array property.
StringArrayAccessor	Provides an accessor for a String array property.
StringArrayAccessor.StringArrayBuilder<B extends StringArrayAccessor.StringArrayBuilder<B>>	Provides a builder method for a String array property returning the builder for applying multiple build operations.
StringArrayAccessor.StringArrayMutator	Provides a mutator for a String array property.
StringArrayAccessor.StringArrayProperty	Provides a String array property.

Class Summary

Class	Description
AttributeImpl	Class describing a beans's attribute.
AttributeImpl.AttributeBuilderImpl	Implementation of the Property.PropertyBuilder interface.
CanonicalMapBuilderImpl	The Class CanonicalMapBuilderImpl.
CanonicalMapImpl	The Class CanonicalMapImpl.
PathComparator	Comparator for path elements.
PathMapBuilderImpl<T>	The Class PathMapBuilderImpl.
PathMapImpl<T>	The Class PathMapImpl.
PropertyImpl	Implementation of the Property interface.
PropertyImpl.PropertyBuilderImpl	Implementation of the Property.PropertyBuilder interface.
RangeImpl<V extends java.lang.Number & java.lang.Comparable<V>>	Implementation of the Range interface.
RangeImpl.RangeBuilderImpl<V extends java.lang.Number & java.lang.Comparable<V>>	Implementation of the Range.RangeBuilder interface.
RelationImpl<K,V>	Implementation of the Relation interface.
RelationImpl.RelationBuilderImpl<K,V>	Implementation of the Relation.RelationBuilder interface.
StructureUtility	Utility class to avoid redundant code regarding various PathMap implementations.
TypeUtility	The Class TypeUtility.

Exception Summary

Exception	Description
AmbigousKeyRuntimeException	Thrown in case this instance does not contain the requested element (no such key found in the collection).
KeyNotFoundException	Thrown in case this instance does not contain the requested element (no such key found in the collection).
KeyNotFoundRuntimeException	Thrown in case this instance does not contain the requested element (no such key found in the collection).
StructureException	The StructureException is the base checked exception for this package.
StructureRuntimeException	The StructureRuntimeException is the base runtime exception for this package.