Package io.streamthoughts.azkarra.api.components

Interface ComponentDescriptorRegistry

All Known Subinterfaces:

ComponentFactory

All Known Implementing Classes:

ContextAwareComponentFactory, DefaultComponentFactory, DelegatingComponentFactory

public interface ComponentDescriptorRegistry

Method Summary

Modifier and Type	Method	Description
<T> Collection<ComponentDescriptor<T>>	findAllDescriptorsByAlias(String alias)	Finds all ComponentDescriptor registered for the specified alias.
<T> Collection<ComponentDescriptor<T>>	findAllDescriptorsByAlias(String alias, Qualifier<T> qualifier)	Finds all ComponentDescriptor registered for the specified alias.
<T> Collection<ComponentDescriptor<T>>	findAllDescriptorsByClass(Class<T> type)	Finds all ComponentDescriptor registered for the specified type.
<T> Collection<ComponentDescriptor<T>>	findAllDescriptorsByClass(Class<T> type, Qualifier<T> qualifier)	Finds all ComponentDescriptor registered for the specified type.
<T> Optional<ComponentDescriptor<T>>	findDescriptorByAlias(String alias)	Finds a ComponentDescriptor for the specified type.
<T> Optional<ComponentDescriptor<T>>	findDescriptorByAlias(String alias, Qualifier<T> qualifier)	Finds a ComponentDescriptor for the specified type and options.
<T> Optional<ComponentDescriptor<T>>	findDescriptorByClass(Class<T> type)	Finds a ComponentDescriptor for the specified type.
<T> Optional<ComponentDescriptor<T>>	findDescriptorByClass(Class<T> type, Qualifier<T> qualifier)	Finds a ComponentDescriptor for the specified type and options.
<T> void	registerDescriptor(ComponentDescriptor<T> descriptor)	Registers the specified ComponentDescriptor to this ComponentRegistry.

Method Detail

findAllDescriptorsByClass

<T> Collection<ComponentDescriptor<T>> findAllDescriptorsByClass(Class<T> type)

Finds all ComponentDescriptor registered for the specified type.

Type Parameters:

T - the component type.

Parameters:

type - the component class.

Returns:

the collection of ComponentDescriptor.

findAllDescriptorsByClass

<T> Collection<ComponentDescriptor<T>> findAllDescriptorsByClass(Class<T> type,
                                                                 Qualifier<T> qualifier)

Finds all ComponentDescriptor registered for the specified type.

Type Parameters:

T - the component type.

Parameters:

type - the component class.

Returns:

the collection of ComponentDescriptor.

findAllDescriptorsByAlias

<T> Collection<ComponentDescriptor<T>> findAllDescriptorsByAlias(String alias)

Finds all ComponentDescriptor registered for the specified alias.

Type Parameters:

T - the component type.

Parameters:

alias - the fully qualified class name or an alias of the component.

Returns:

the collection of ComponentDescriptor.

findAllDescriptorsByAlias

<T> Collection<ComponentDescriptor<T>> findAllDescriptorsByAlias(String alias,
                                                                 Qualifier<T> qualifier)

Finds all ComponentDescriptor registered for the specified alias.

Type Parameters:

T - the component type.

Parameters:

alias - the fully qualified class name or an alias of the component.

Returns:

the collection of ComponentDescriptor.

findDescriptorByAlias

<T> Optional<ComponentDescriptor<T>> findDescriptorByAlias(String alias)

Finds a ComponentDescriptor for the specified type.

Type Parameters:

T - the component type.

Parameters:

alias - the fully qualified class name or an alias of the component.

Returns:

the optional ComponentDescriptor instance.

Throws:

NoUniqueComponentException - if more than one component is registered for the given type.

findDescriptorByAlias

<T> Optional<ComponentDescriptor<T>> findDescriptorByAlias(String alias,
                                                           Qualifier<T> qualifier)

Finds a ComponentDescriptor for the specified type and options.

Type Parameters:

T - the component type.

Parameters:

alias - the fully qualified class name or an alias of the component.

qualifier - the options used to qualified the component.

Returns:

the optional ComponentDescriptor instance.

Throws:

NoUniqueComponentException - if more than one component is registered for the given type.

findDescriptorByClass

<T> Optional<ComponentDescriptor<T>> findDescriptorByClass(Class<T> type)

Finds a ComponentDescriptor for the specified type.

Type Parameters:

T - the component type.

Parameters:

type - the component class.

Returns:

the optional ComponentDescriptor instance.

Throws:

NoUniqueComponentException - if more than one component is registered for the given type.

findDescriptorByClass

<T> Optional<ComponentDescriptor<T>> findDescriptorByClass(Class<T> type,
                                                           Qualifier<T> qualifier)

Finds a ComponentDescriptor for the specified type and options.

Type Parameters:

T - the component type.

Parameters:

type - the fully qualified class name or an alias of the component.

qualifier - the options used to qualified the component.

Returns:

the optional ComponentDescriptor instance.

Throws:

NoUniqueComponentException - if more than one component is registered for the given type.

registerDescriptor

<T> void registerDescriptor(ComponentDescriptor<T> descriptor)

Registers the specified ComponentDescriptor to this ComponentRegistry.

Type Parameters:

T - the component type.

Parameters:

descriptor - the ComponentDescriptor instance to be registered.

Throws:

ConflictingComponentDefinitionException - if a component is already register for that descriptor.