Package org.carrot2.util.attribute

A framework for managing Carrot² component attributes.

See:
Description

Interface Summary

AttributeBinder.IAttributeBinderAction	An action to be applied during attribute binding.
AttributeBinder.IAttributeTransformer	Transforms attribute values.
IBindableDescriptor	Additional, statically derived, metadata describing a Bindable component.

Class Summary

AnnotationsPredicate	A predicate that tests the presence of a given set of annotations on an AttributeDescriptor.
AttributeBinder	Provides methods for binding (setting and getting) values of attributes defined by the Attribute annotation.
AttributeBinder.AllAnnotationsPresentPredicate	A predicate that evaluates to true if the attribute is annotated with all of the provided annotations.
AttributeBinder.AttributeBinderActionBind	An action that binds all Input attributes.
AttributeBinder.AttributeBinderActionCollect	An action that binds all Output attributes.
AttributeBinder.AttributeTransformerFromString	Transforms String attribute values to the types required by the target field by: Leaving non-String typed values unchanged. Looking for a static valueOf(String) in the target type and using it for conversion. If the method is not available, trying to load a class named as the value of the attribute, so that this class can be further coerced to the class instance. If the class cannot be loaded, leaving the the value unchanged.
AttributeBinder.BindingTracker	Tracks which attributes have already been collected and prevents overwriting of collected values.
AttributeBinderInjector	A very simple field value injector based on the AttributeBinder.
AttributeDescriptor	Provides a full description of an individual attribute, including its AttributeDescriptor.key, AttributeDescriptor.type, AttributeDescriptor.defaultValue and AttributeDescriptor.constraints.
AttributeDescriptor.AttributeDescriptorToKey	Transforms AttributeDescriptors into their keys.
AttributeInfo	Description of an Attribute of a Bindable type, including javadoc documentation and compile-time extracted tags.
AttributeUtils	A number of utility methods for working with Attributes.
AttributeValueSet	Maintains a named set of attribute values.
AttributeValueSets	Maintains a collection of AttributeValueSets and provides methods for serializing and deserializing attribute value sets from XML streams.
BindableDescriptor	Provides a full description of a Bindable type, including AttributeDescriptors for all attributes defined by the type.
BindableDescriptorBuilder	Builds BindableDescriptors based on the provided bindable type instances.
BindableDescriptorUtils	Utilities related to generated bindable descriptors.
BindableUtils	A set of utility methods for working with Bindable types.
LevelsPredicate	A predicate that tests whether an AttributeDescriptor belongs to any of the provided levels.

Enum Summary

AttributeLevel	The level of complexity involved in tuning an attribute value.
BindableDescriptor.GroupingMethod	The supported AttributeDescriptor grouping methods.

Exception Summary

AttributeBindingException

An exception thrown when problems occur in AttributeBinder.set(Object, java.util.Map, Class...).

Annotation Types Summary

Attribute	Denotes fields whose values should be bound (set or collected) by AttributeBinder.
Bindable	Denotes types that will have some of their fields bound (set or collected) by the AttributeBinder.
Input	Denotes fields whose values can be set (written) by AttributeBinder.
Output	Denotes fields whose values can be read (collected) by AttributeBinder.
Required	Marks required attributes.

Package org.carrot2.util.attribute Description

A framework for managing Carrot² component attributes.