Package org.jvnet.hk2.config
-
Interface Summary Interface Description Changed Objects that do not wish to process the entire change set of a transaction can implement this interface and use it to invoke utility methods on ConfigSupport.ConfigBeanInterceptor<T> Interceptor interface to be notified of read/write operations on a ConfigBean.ConfigBeanProxy Marker interface that signifies that the interface is meant to be used as a strongly-typed proxy toDom
.ConfigBeanProxyCustomizer ConfigCode Allows multiple object as part of the transaction but requires manual casting.ConfigExtensionHandler<T extends ConfigBeanProxy> ConfigListener Any object injected with Configured object and willing to receive notifications of changes should implement this interface.ConfigView All views of @Configured interface implementation must implement this interfaceConstrainedBeanListener Interface allowing to register a listener for vetoable events.DataType Denotes thetype
of the data a particular config element (attribute, element) should have.DomDecorator<T extends Dom> InjectionResolverQuery ObservableBean Implementation of a @Configured object can optionally fire configuration change events when it's mutated.Populator PopulatesHabitat
.SingleConfigCode<T extends ConfigBeanProxy> SimpleConfigCode is code snippet that can be used to apply some configuration changes to one configuration object.TransactionCallBack<T> Transactional callbackTransactionListener Listener interface for objects interested in transaction events on the config beans.Transactor Any object that want to be part of a configuration transaction should implement this interface.Transformer Transfomer can transform a source object into a destination object, usually providing a different view of the original object.Translator Used to perform string pre-processing on values found in the configuration file.VersionedConfigBeanProxy -
Class Summary Class Description AttributeChanges ConfigBean ConfigBean is the core implementation of the config beans.ConfigBeanProxy.Duck ConfigInjector<T> Inject configuration values to the object.ConfigMetadata Constant names used in the metadata for configurable inhabitants.ConfigModel Describes the configuration model for a particular class (called "target type" in this class.) TODO: we need to remember if element values are single-valued or multi-valued.ConfigModel.Node ConfigModel.Property ConfigParser Parses configuration files, buildsInhabitant
s, and add them toHabitat
.ConfigSupport Helper class to execute some code on configuration objects while taking care of the transaction boiler plate code.ConfigSupport.MultipleAttributeChanges ConfigSupport.SingleAttributeChange ConfigurationPopulator Populates configuration entitiesDom Inhabitant
that loads configuration from XML.DomDescriptor<T> Created by IntelliJ IDEA.DomDocument<T extends Dom> Represents a whole DOM tree.HK2DomConfigUtilities Utilities for working with HK2 configIndentingXMLStreamWriter InjectionManager InjectionManager is responsible for injecting resources into a component.InjectionManager.InjectContext InjectionResolver<U extends Annotation> Implementation of this abstract class are handling injection resolution for a particular injection annotation {@see Inject} Injection targets are identified by the generic parameter and the constructor of this class.MessageInterpolatorImpl NoopConfigInjector Used for bringing inConfigBeanProxy
to the habitat.NotProcessed An explanation of a change could not be processed.OnDeleteCascade Usage:class ExampleDocument extends DomDocument
{ PrimitiveDataType Represents a Java primitive (and its wrapper) data type.Transaction Simple transaction mechanism for config-api objectsTransactions Transactions is a singleton service that receives transaction notifications and dispatch these notifications asynchronously to listeners.UnprocessedChangeEvent Carries the PropertyChangeEvent and the reason it could not be processed.UnprocessedChangeEvents Collects change events that could not be processed.VariableResolver Translator
that does variable resolution in the Ant style.WorkManager Simple helper for managing work sent to a foreign executor service.WriteableView A WriteableView is a view of a ConfigBean object that allow access to the setters of the ConfigBean. -
Enum Summary Enum Description Changed.TYPE type of change on a particular instance -
Exception Summary Exception Description ConfigPopulatorException Indicates a problem during population on config beans.ConfigurationException Indicates a problem in the configuration value.RetryableException RetryableException indicates that an operation failed to execute property but could be successful in a later attemptTransactionFailure Simple transaction failure exceptionTranslationException Indicates a failure inTranslator.translate(String)
.UnsatisfiedDependencyException Exception thrown by the injection manager when a dependency is not satisfied when performing injection.ValidationException WorkManager.ExecutionException XMLStreamException2 To fix the problem in StAX API where exceptions are not properly chained. -
Annotation Types Summary Annotation Type Description Attribute Indicates that this property or the field value must be injected from an XML attribute in a configuration file.ConfigExtensionMethod Configured Marks inhabitants that require configuration for instantiation.ConfiguredBy Contract-like annotation used on services indicating that their lifecycle is governed by theConfigured
bean they are associated with, and configured by.DuckTyped Indicates that this method onConfigBeanProxy
is a duck-typed method that are implemented by the static method on the nested staticDuck
class.Element Indicates that this property or the field value must be injected from an XML element in a configuration file.GeneratedServiceName This annotation may be placed on one String method of an annotation marked withGenerateServiceFromMethod
to indicate that this method contains the name the service should take.GenerateServiceFromMethod This annotation is put on user-supplied annotations in order to cause the hk2-inhabitant-generator tool to create descriptors with certain properties.InjectionTarget Used onConfigInjector
to indicate the target class of the injection.Units Units annotation to be used on @Configured interfaces.