sirius.kernel.di.transformers

Class Composable

java.lang.Object

sirius.kernel.di.transformers.Composable

All Implemented Interfaces:

Transformable

public class Composable
extends Object
implements Transformable

Provides a basic implementation fo Transformable which supports a composition pattern.

Next to the Adapter Pattern supported via Transformers, this implementation permits to add components via the attach methods which can later be queried via tryAs, as and is.

This class can be used as base class or embedded into another class (using Composable(Object)) to make it Transformable.

Field Summary

Fields

Modifier and Type	Field and Description
protected Map<Class<?>,Object>	components

Constructor Summary

Constructors

Constructor and Description
Composable() Default constructor used, when Composable is used as parent class.
Composable(Object source) Provides a constructor which can be used to support the composition pattern.

Method Summary

Modifier and Type	Method and Description
<A> A	as(Class<A> adapterType) Adapts this into the given adapterType.
<T> void	attach(Class<? extends T> type, T component) Adds the given component as instance for the given type.
void	attach(Object component) Adds the given component as instance for its class.
boolean	is(Class<?> adapterType) Determines if this can be transformed to the given type.
<A> Optional<A>	tryAs(Class<A> adapterType) Tries to transform this into the given adapterType.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

components

protected Map<Class<?>,Object> components

Constructor Detail

Composable

public Composable()

Default constructor used, when Composable is used as parent class.

Composable

public Composable(Object source)

Provides a constructor which can be used to support the composition pattern.

Parameters:

source - the class or object which is made Transformable.

Method Detail

is

public boolean is(@Nonnull
                  Class<?> adapterType)

Description copied from interface: Transformable

Determines if this can be transformed to the given type.

Specified by:

is in interface Transformable

Parameters:

adapterType - the target type to check for

Returns:

true if this implements the type already or it can be transformed into the given type

as

public <A> A as(@Nonnull
                Class<A> adapterType)

Description copied from interface: Transformable

Adapts this into the given adapterType.

Specified by:

as in interface Transformable

Type Parameters:

A - the type of the adapter type

Parameters:

adapterType - the target type to adapt to

Returns:

this adapted to match the requested adapterType

tryAs

public <A> Optional<A> tryAs(@Nonnull
                             Class<A> adapterType)

Description copied from interface: Transformable

Tries to transform this into the given adapterType.

Specified by:

tryAs in interface Transformable

Type Parameters:

A - the type of the adapter type

Parameters:

adapterType - the target type to adapt to

Returns:

an optional which either contains the adapted value matching the requested adapterType or an empty optional if no transformation was possible

attach

public <T> void attach(Class<? extends T> type,
                       T component)

Adds the given component as instance for the given type.

Type Parameters:

T - the generic type which ensures, that the component actually implements the given type

Parameters:

type - the type of the component which can be used to later retrieve the component

component - the component itself

attach

public void attach(Object component)

Adds the given component as instance for its class.

This is a boilerplate method for attach(component.getClass(), component).

Parameters:

component - the component to attach for its own class