Module org.microbean.type

Package org.microbean.type

Class CdiType

java.lang.Object

org.microbean.type.Type<Type>

org.microbean.type.JavaType

org.microbean.type.CdiType

All Implemented Interfaces:

Owner<Type>

public class CdiType
extends JavaType

A JavaType with a flexible means of describing its direct supertypes, suitable only, probaly, for CDI use cases.

Author:

Laird Nelson

Nested Class Summary

Nested classes/interfaces inherited from class org.microbean.type.JavaType

JavaType.Token<T>

Nested classes/interfaces inherited from class org.microbean.type.Type

Type.CdiSemantics, Type.CovariantSemantics, Type.InvariantSemantics, Type.Semantics, Type.VariantSemantics

Field Summary

Fields inherited from class org.microbean.type.JavaType

wrapperTypes

Constructor Summary

Constructors

Constructor	Description
CdiType(Type type, Function<Type,Collection<Type>> directSupertypesFunction)	Creates a new CdiType.

Method Summary

Modifier and Type	Method	Description
Collection<JavaType>	directSupertypes()	Returns an unmodifiable and immutable Collection of the direct supertypes of this CdiType as provided by the directSupertypesFunction supplied at construction time.
static final CdiType	of(Type type)	Creates a new CdiType.
static JavaType	of(Type type, boolean box)	Creates a new CdiType.
static final CdiType	of(JavaType.Token<?> type)	Creates a new CdiType.
static final CdiType	of(JavaType.Token<?> type, boolean box)	Creates a new CdiType.

Methods inherited from class org.microbean.type.JavaType

box, componentType, equals, hashCode, hasTypeArguments, hasTypeParameters, lowerBounded, lowerBounds, name, named, owner, represents, top, type, typeArguments, typeParameters, upperBounded, upperBounds

Methods inherited from class org.microbean.type.Type

genericArrayType, hasParameters, isClass, object, parameterizedType, parameters, supertype, supertypes, typeVariable, wildcard

Methods inherited from class java.lang.Object

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

Constructor Details

CdiType

public CdiType(Type type,
 Function<Type,Collection<Type>> directSupertypesFunction)

Creates a new CdiType.

Parameters:

type - the Type being modeled; must not be null; must be a legal CDI bean type

directSupertypesFunction - a Function that, when supplied with a Type (which will be the type parameter value), returns those Types which are its direct supertypes; must not be null

Throws:

NullPointerException - if any argument is null

Method Details

directSupertypes

public Collection<JavaType> directSupertypes()

Returns an unmodifiable and immutable Collection of the direct supertypes of this CdiType as provided by the directSupertypesFunction supplied at construction time.

Overrides:

directSupertypes in class JavaType

Returns:

an unmodifiable and immutable Collection of the direct supertypes of this JavaType; never null

Idempotency:

This method is, and its overrides must be, idempotent and deterministic, though the ordering of elements within returned Collections is undefined

Nullability:

This method does not, and its overrides must not, return null.

Thread Safety:

This method is, and its overrides must be, safe for concurrent use by multiple threads.

of

public static final CdiType of(JavaType.Token<?> type)

Creates a new CdiType.

Parameters:

type - a JavaType.Token representing the type to model; must not be null

Returns:

a new CdiType; never null

Throws:

NullPointerException - if type is null.

See Also:

• of(Type)

Idempotency:

This method is idempotent but not deterministic (in that it returns a new CdiType with each invocation). However, any CdiType returned from this method is guaranteed to equal any other CdiType returned from this method, provided the inputs to all invocations are equal.

Nullability:

This method never returns null.

Thread Safety:

This method is safe for concurrent use by multiple threads.

of

public static final CdiType of(JavaType.Token<?> type,
 boolean box)

Creates a new CdiType.

Parameters:

type - a JavaType.Token representing the type to model; must not be null

box - whether autoboxing is enabled; must be true because CDI requires autoboxing; see JavaType.of(Token, boolean) which this method shadows

Returns:

a new CdiType; never null

Throws:

NullPointerException - if type is null.

IllegalArgumentException - if box is false; CDI requires autoboxing

See Also:

• of(Type)

Idempotency:

This method is idempotent but not deterministic (in that it returns a new CdiType with each invocation). However, any CdiType returned from this method is guaranteed to equal any other CdiType returned from this method, provided the inputs to all invocations are equal.

Nullability:

This method never returns null.

Thread Safety:

This method is safe for concurrent use by multiple threads.

of

public static final CdiType of(Type type)

Creates a new CdiType.

Parameters:

type - the Type that will be modeled; must not be null

Returns:

a new CdiType; never null

Throws:

NullPointerException - if type is null.

Idempotency:

This method is idempotent but not deterministic (in that it returns a new CdiType with each invocation). However, any CdiType returned from this method is guaranteed to equal any other CdiType returned from this method, provided the inputs to all invocations are equal.

Nullability:

This method never returns null.

Thread Safety:

This method is safe for concurrent use by multiple threads.

of

public static JavaType of(Type type,
 boolean box)

Creates a new CdiType.

Parameters:

type - the Type that will be modeled; must not be null

box - whether autoboxing is enabled; must be true because CDI requires autoboxing; see JavaType.of(Type, boolean) which this method shadows

Returns:

a new CdiType; never null

Throws:

NullPointerException - if type is null.

IllegalArgumentException - if box is false; CDI requires autoboxing

See Also:

• of(Type)

Idempotency:

This method is idempotent but not deterministic (in that it returns a new CdiType with each invocation). However, any CdiType returned from this method is guaranteed to equal any other CdiType returned from this method, provided the inputs to all invocations are equal.

Nullability:

This method never returns null.

Thread Safety:

This method is safe for concurrent use by multiple threads.