Type Parameters:

T - the component type.

All Superinterfaces:

Comparable<Ordered>, Ordered

All Known Implementing Classes:

ComponentDescriptorBuilder, SimpleComponentDescriptor, TopologyDescriptor
```
public interface ComponentDescriptor<T>
extends Ordered
```
Describes a single component managed by a ComponentFactory.

Field Summary

Fields
Modifier and Type Field Description

static Comparator<ComponentDescriptor<?>> ORDER_BY_ORDER

static Comparator<ComponentDescriptor<?>> ORDER_BY_VERSION
- Fields inherited from interface io.streamthoughts.azkarra.api.components.Ordered
  HIGHEST_ORDER, LOWEST_ORDER

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method	Description
`void`	`addAliases(Set<String> aliases)`	Adds new aliases to reference the described component.
`Set<String>`	`aliases()`	Gets the set of aliases for this component.
`ClassLoader`	`classLoader()`	Gets the classloader used to load the component.
`default String`	`className()`	Gets the name of the describe component.
`Optional<Condition>`	`condition()`	Gets the `Condition` that need to be fulfilled for this component to be eligible for use in the application.
`default boolean`	`isCloseable()`	Checks if the described component implement `Closeable`.
`boolean`	`isEager()`	Checks if the described component should be create and configure eagerly.
`boolean`	`isPrimary()`	Checks if the described component is the primary component that must be selected in the case of multiple possible implementations.
`boolean`	`isSecondary()`	Checks if the described component is a secondary component that must be de-prioritize in the case of multiple possible implementations.
`boolean`	`isSingleton()`	Checks if the described component is a singleton.
`default boolean`	`isVersioned()`	Checks whether the described component has a valid versioned.
`ComponentMetadata`	`metadata()`	Gets the component metadata.
`String`	`name()`	Gets the name of the component.
`Supplier<T>`	`supplier()`	Gets the supplier used to create a new component of type `ComponentDescriptor`.
`Class<T>`	`type()`	Gets the type of the described component.
`Version`	`version()`	Gets the version of the described component.

Methods inherited from interface io.streamthoughts.azkarra.api.components.Ordered
compareTo, order

- Field Detail
  - ORDER_BY_VERSION
```
static final Comparator<ComponentDescriptor<?>> ORDER_BY_VERSION
```
  - ORDER_BY_ORDER
```
static final Comparator<ComponentDescriptor<?>> ORDER_BY_ORDER
```
- Method Detail
  - name
```
String name()
```
    Gets the name of the component.
    
    Returns:
    
    the name, or null if the name is not set.
  - metadata
```
ComponentMetadata metadata()
```
    Gets the component metadata.
    
    Returns:
    
    the ComponentMetadata.
  - classLoader
```
ClassLoader classLoader()
```
    Gets the classloader used to load the component.
    
    Returns:
    
    the ClassLoader.
  - addAliases
```
void addAliases(Set<String> aliases)
```
    Adds new aliases to reference the described component.
    
    Parameters:
    
    aliases - the aliases to be added.
  - aliases
```
Set<String> aliases()
```
    Gets the set of aliases for this component.
    
    Returns:
    
    the aliases.
  - className
```
default String className()
```
    Gets the name of the describe component.
    
    Returns:
    
    the name.
  - version
```
Version version()
```
    Gets the version of the described component.
    
    Returns:
    
    the component version if versioned, otherwise null.
  - supplier
```
Supplier<T> supplier()
```
    Gets the supplier used to create a new component of type ComponentDescriptor.
    
    Returns:
    
    the Supplier.
  - isVersioned
```
default boolean isVersioned()
```
    Checks whether the described component has a valid versioned.
    
    Returns:
    
    true if versioned, otherwise false.
  - type
```
Class<T> type()
```
    Gets the type of the described component.
    
    Returns:
    
    the class of type T.
  - isCloseable
```
default boolean isCloseable()
```
    Checks if the described component implement Closeable.
    
    Returns:
    
    true if closeable, otherwise false.
  - isSingleton
```
boolean isSingleton()
```
    Checks if the described component is a singleton.
    
    Returns:
    
    true if is singleton, otherwise false.
  - isPrimary
```
boolean isPrimary()
```
    Checks if the described component is the primary component that must be selected in the case of multiple possible implementations.
    
    Returns:
    
    true if is primary, otherwise false.
    
    See Also:
    
    Qualifiers.byPrimary()
  - isSecondary
```
boolean isSecondary()
```
    Checks if the described component is a secondary component that must be de-prioritize in the case of multiple possible implementations.
    
    Returns:
    
    true if is secondary, otherwise false.
    
    See Also:
    
    Qualifiers.bySecondary(), Qualifiers.excludeSecondary()
  - isEager
```
boolean isEager()
```
    Checks if the described component should be create and configure eagerly.
    
    Returns:
    
    true if it s an eager component, otherwise false.
    
    See Also:
    
    Eager
  - condition
```
Optional<Condition> condition()
```
    Gets the Condition that need to be fulfilled for this component to be eligible for use in the application.
    
    Returns:
    
    the Conditions.

Modifier and Type	Field	Description
`static Comparator<ComponentDescriptor<?>>`	`ORDER_BY_ORDER`
`static Comparator<ComponentDescriptor<?>>`	`ORDER_BY_VERSION`

Interface ComponentDescriptor<T>

Field Summary

Fields inherited from interface io.streamthoughts.azkarra.api.components.Ordered

Method Summary

Methods inherited from interface io.streamthoughts.azkarra.api.components.Ordered

Field Detail

ORDER_BY_VERSION

ORDER_BY_ORDER

Method Detail

name

metadata

classLoader

addAliases

aliases

className

version

supplier

isVersioned

type

isCloseable

isSingleton

isPrimary

isSecondary

isEager

condition