Module org.microbean.bean

Package org.microbean.bean

Class BeanTypes

java.lang.Object

org.microbean.bean.BeanTypes

All Implemented Interfaces:

Constable

public final class BeanTypes
extends Object
implements Constable

A utility for working with bean types.

Author:

Laird Nelson

See Also:

• beanTypes(TypeMirror)
• legalBeanType(TypeMirror)

Constructor Summary

Constructors

Constructor	Description
BeanTypes(TypeAndElementSource tes)	Creates a new BeanTypes.

Method Summary

Modifier and Type	Method	Description
final List<TypeMirror>	beanTypes(TypeMirror t)	Returns an immutable List of legal bean types that the supplied TypeMirror bears.
final void	clearCaches()	Clears caches that may be used internally by this BeanTypes.
final Optional<? extends ConstantDesc>	describeConstable()	Returns an Optional housing a ConstantDesc that represents this BeanTypes.
static final boolean	legalBeanType(TypeMirror t)	Returns true if and only if the supplied TypeMirror is a legal bean type.

Methods inherited from class java.lang.Object

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

Constructor Details

BeanTypes

public BeanTypes(TypeAndElementSource tes)

Creates a new BeanTypes.

Parameters:

tes - a TypeAndElementSource; must not be null

Method Details

describeConstable

public final Optional<? extends ConstantDesc> describeConstable()

Returns an Optional housing a ConstantDesc that represents this BeanTypes.

This method never returns null.

The default implementation of this method relies on the presence of a public constructor that accepts a single TypeAndElementSource-typed argument.

The Optional returned by an invocation of this method may be, and often will be, empty.

Specified by:

describeConstable in interface Constable

Returns:

an Optional housing a ConstantDesc that represents this BeanTypes; never null

See Also:

• Constable.describeConstable()

clearCaches

public final void clearCaches()

Clears caches that may be used internally by this BeanTypes.

Idempotency:

This method may clear internal state but otherwise has no side effects.

Thread Safety:

This method is safe for concurrent use by multiple threads.

beanTypes

public final List<TypeMirror> beanTypes(TypeMirror t)

Returns an immutable List of legal bean types that the supplied TypeMirror bears.

The returned List may be empty.

Parameters:

t - a TypeMirror; must not be null

Returns:

an immutable List of legal bean types that the supplied TypeMirror bears; never null

Throws:

NullPointerException - if t is null

Idempotency:

This method is idempotent and returns determinate values.

Nullability:

This method never returns null.

Thread Safety:

This method is safe for concurrent use by multiple threads.

legalBeanType

public static final boolean legalBeanType(TypeMirror t)

Returns true if and only if the supplied TypeMirror is a legal bean type.

Legal bean types are, exactly:

1. Array types whose component types are legal bean types
2. Primitive types
3. Declared types that contain no wildcard types for every level of containment

Parameters:

t - a TypeMirror; must not be null

Returns:

true if and only if t is a legal bean type; false otherwise

Throws:

NullPointerException - if t is null

Idempotency:

This method is idempotent and deterministic.

Thread Safety:

This method itself is safe for concurrent use by multiple threads, but TypeMirror implementations and TypeAndElementSource implementations may not be safe for such use.