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 aString
and the value being of any type.Attribute.AttributeBuilder Adds builder functionality to anAttribute
.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 TheCanonicalMap
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 AContainable
is the base functionality provided container (collection).Container<E> Basic functionality being provided by anyContainer
(collection) style class.Container.ClearableContainer<E> Container.MutableContainer<E> Extends theContainer
with mutable (writable) functionality, especially by enabling theIterator.remove()
method in theIterator
provided viaElements.iterator()
.Dictionary<K,V> Basic functionality being provided by anyDictionary
(map) style class.Dictionary.MutableDictionary<K,V> Extends theDictionary
with mutable (writable) functionality, especially by providingKeys.MutableValues.put(Object, Object)
andKeys.MutableKeys.delete(String)
methods.Dictionary.MutableDictionary.DictionaryBuilder<K,V,B extends Dictionary.MutableDictionary.DictionaryBuilder<K,V,B>> Provides a builder method for aRelation
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 anyElements
(collection) style class.Elements.ClearableElements<E> Elements.MutableElements<E> Extends theElements
with mutable (writable) functionality, especially by enabling theIterator.remove()
method in theIterator
provided viaElements.MutableElements.iterator()
and by providing theElements.MutableElements.add(Object)
and theElements.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 theKeys
interface.Keys.MutableValues<K,V> Mixin for mutable functionality accompanying theKeys
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> PathMap.MutablePathMap<T> Extends thePathMap
with mutator functionality.PathMap.PathMapBuilder<T> Extends thePathMap
with mutator functionality.PropertiesAccessorMixin PropertiesAccessorMixin.PropertiesBuilderMixin<T> PropertiesAccessorMixin.PropertiesMixin Mixin with lots of accessing and mutating default methods forString
key/valueMap
orDictionary
implementations.PropertiesAccessorMixin.PropertiesMutatorMixin Property AProperty
is defined as beingString
representing a property's key and aString
representing the proprty's value.Property.PropertyBuilder Adds builder functionality to aProperty
.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 aRange
.Relation<K,V> Provides an accessor for a key-to-value property useful in some occasions.Relation.RelationBuilder<K,V> Adds builder functionality to aRelation
.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 theProperty.PropertyBuilder
interface.CanonicalMapBuilderImpl The Class CanonicalMapBuilderImpl.CanonicalMapImpl The Class CanonicalMapImpl.PathMapBuilderImpl<T> The Class PathMapBuilderImpl.PathMapImpl<T> The Class PathMapImpl.PropertyImpl Implementation of theProperty
interface.PropertyImpl.PropertyBuilderImpl Implementation of theProperty.PropertyBuilder
interface.RangeImpl<V extends java.lang.Number & java.lang.Comparable<V>> The Class RangeImpl.RangeImpl.RangeBuilderImpl<V extends java.lang.Number & java.lang.Comparable<V>> The Class RangeBuilderImpl.RelationImpl<K,V> Implementation of theRelation
interface.RelationImpl.RelationBuilderImpl<K,V> Implementation of theRelation.RelationBuilder
interface.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 TheStructureException
is the base checked exception for this package.StructureRuntimeException TheStructureRuntimeException
is the base runtime exception for this package.