Class Constables

java.lang.Object

org.microbean.construct.constant.Constables

public final class Constables
extends Object

A utility class that returns nominal descriptors for constructs.

Author:

Laird Nelson

See Also:

• describe(Element, Domain)
• describe(TypeMirror, Domain)

Method Summary

Modifier and Type	Method	Description
static final Optional<? extends ConstantDesc>	describe(AnnotatedConstruct ac, Domain d)	Returns a nominal descriptor for the supplied argument, presuming it to have originated from the supplied Domain, or an empty Optional if the supplied argument cannot be described.
static final Optional<? extends ConstantDesc>	describe(Element e, Domain d)	Returns a nominal descriptor for the supplied argument, presuming it to have originated from the supplied Domain, or an empty Optional if the supplied argument cannot be described.
static final Optional<? extends ConstantDesc>	describe(ExecutableElement e, Domain d)	Returns a nominal descriptor for the supplied argument, presuming it to have originated from the supplied Domain, or an empty Optional if the supplied argument cannot be described.
static final Optional<? extends ConstantDesc>	describe(ModuleElement e, Domain d)	Returns a nominal descriptor for the supplied argument, presuming it to have originated from the supplied Domain, or an empty Optional if the supplied argument cannot be described.
static final Optional<? extends ConstantDesc>	describe(Name n, Domain d)	Returns a nominal descriptor for the supplied argument, presuming it to have originated from the supplied Domain, or an empty Optional if the supplied argument cannot be described.
static final Optional<? extends ConstantDesc>	describe(PackageElement e, Domain d)	Returns a nominal descriptor for the supplied argument, presuming it to have originated from the supplied Domain, or an empty Optional if the supplied argument cannot be described.
static final Optional<? extends ConstantDesc>	describe(RecordComponentElement e, Domain d)	Returns a nominal descriptor for the supplied argument, presuming it to have originated from the supplied Domain, or an empty Optional if the supplied argument cannot be described.
static final Optional<? extends ConstantDesc>	describe(TypeElement e, Domain d)	Returns a nominal descriptor for the supplied argument, presuming it to have originated from the supplied Domain, or an empty Optional if the supplied argument cannot be described.
static final Optional<? extends ConstantDesc>	describe(TypeParameterElement e, Domain d)	Returns a nominal descriptor for the supplied argument, presuming it to have originated from the supplied Domain, or an empty Optional if the supplied argument cannot be described.
static final Optional<? extends ConstantDesc>	describe(VariableElement e, Domain d)	Returns a nominal descriptor for the supplied argument, presuming it to have originated from the supplied Domain, or an empty Optional if the supplied argument cannot be described.
static final Optional<? extends ConstantDesc>	describe(ArrayType t, Domain d)	Returns a nominal descriptor for the supplied argument, presuming it to have originated from the supplied Domain, or an empty Optional if the supplied argument cannot be described.
static final Optional<? extends ConstantDesc>	describe(DeclaredType t, Domain d)	Returns a nominal descriptor for the supplied argument, presuming it to have originated from the supplied Domain, or an empty Optional if the supplied argument cannot be described.
static final Optional<? extends ConstantDesc>	describe(NoType t, Domain d)	Returns a nominal descriptor for the supplied argument, presuming it to have originated from the supplied Domain, or an empty Optional if the supplied argument cannot be described.
static final Optional<? extends ConstantDesc>	describe(NullType t, Domain d)	Returns a nominal descriptor for the supplied argument, presuming it to have originated from the supplied Domain, or an empty Optional if the supplied argument cannot be described.
static final Optional<? extends ConstantDesc>	describe(PrimitiveType t, Domain d)	Returns a nominal descriptor for the supplied argument, presuming it to have originated from the supplied Domain, or an empty Optional if the supplied argument cannot be described.
static final Optional<? extends ConstantDesc>	describe(TypeMirror t, Domain d)	Returns a nominal descriptor for the supplied argument, presuming it to have originated from the supplied Domain, or an empty Optional if the supplied argument cannot be described.
static final Optional<? extends ConstantDesc>	describe(TypeVariable t, Domain d)	Returns a nominal descriptor for the supplied argument, presuming it to have originated from the supplied Domain, or an empty Optional if the supplied argument cannot be described.
static final Optional<? extends ConstantDesc>	describe(WildcardType t, Domain d)	Returns a nominal descriptor for the supplied argument, presuming it to have originated from the supplied Domain, or an empty Optional if the supplied argument cannot be described.

Methods inherited from class java.lang.Object

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

Method Details

describe

public static final Optional<? extends ConstantDesc> describe(Name n,
 Domain d)

Returns a nominal descriptor for the supplied argument, presuming it to have originated from the supplied Domain, or an empty Optional if the supplied argument cannot be described.

Parameters:

n - the argument; may be null

d - the Domain from which the argument originated; must not be null

Returns:

a non-null Optional

Throws:

NullPointerException - if d is null

describe

public static final Optional<? extends ConstantDesc> describe(AnnotatedConstruct ac,
 Domain d)

Returns a nominal descriptor for the supplied argument, presuming it to have originated from the supplied Domain, or an empty Optional if the supplied argument cannot be described.

Parameters:

ac - the argument; may be null

d - the Domain from which the argument originated; must not be null

Returns:

a non-null Optional

Throws:

NullPointerException - if d is null

describe

public static final Optional<? extends ConstantDesc> describe(Element e,
 Domain d)

Returns a nominal descriptor for the supplied argument, presuming it to have originated from the supplied Domain, or an empty Optional if the supplied argument cannot be described.

Parameters:

e - the argument; may be null

d - the Domain from which the argument originated; must not be null

Returns:

a non-null Optional

Throws:

NullPointerException - if d is null

describe

public static final Optional<? extends ConstantDesc> describe(ExecutableElement e,
 Domain d)

Returns a nominal descriptor for the supplied argument, presuming it to have originated from the supplied Domain, or an empty Optional if the supplied argument cannot be described.

Parameters:

e - the argument; may be null

d - the Domain from which the argument originated; must not be null

Returns:

a non-null Optional

Throws:

NullPointerException - if d is null

describe

public static final Optional<? extends ConstantDesc> describe(ModuleElement e,
 Domain d)

Returns a nominal descriptor for the supplied argument, presuming it to have originated from the supplied Domain, or an empty Optional if the supplied argument cannot be described.

Parameters:

e - the argument; may be null

d - the Domain from which the argument originated; must not be null

Returns:

a non-null Optional

Throws:

NullPointerException - if d is null

describe

public static final Optional<? extends ConstantDesc> describe(PackageElement e,
 Domain d)

Returns a nominal descriptor for the supplied argument, presuming it to have originated from the supplied Domain, or an empty Optional if the supplied argument cannot be described.

Parameters:

e - the argument; may be null

d - the Domain from which the argument originated; must not be null

Returns:

a non-null Optional

Throws:

NullPointerException - if d is null

describe

public static final Optional<? extends ConstantDesc> describe(TypeElement e,
 Domain d)

Returns a nominal descriptor for the supplied argument, presuming it to have originated from the supplied Domain, or an empty Optional if the supplied argument cannot be described.

Parameters:

e - the argument; may be null

d - the Domain from which the argument originated; must not be null

Returns:

a non-null Optional

Throws:

NullPointerException - if d is null

describe

public static final Optional<? extends ConstantDesc> describe(TypeParameterElement e,
 Domain d)

Returns a nominal descriptor for the supplied argument, presuming it to have originated from the supplied Domain, or an empty Optional if the supplied argument cannot be described.

Parameters:

e - the argument; may be null

d - the Domain from which the argument originated; must not be null

Returns:

a non-null Optional

Throws:

NullPointerException - if d is null

describe

public static final Optional<? extends ConstantDesc> describe(RecordComponentElement e,
 Domain d)

Returns a nominal descriptor for the supplied argument, presuming it to have originated from the supplied Domain, or an empty Optional if the supplied argument cannot be described.

Parameters:

e - the argument; may be null

d - the Domain from which the argument originated; must not be null

Returns:

a non-null Optional

Throws:

NullPointerException - if d is null

describe

public static final Optional<? extends ConstantDesc> describe(VariableElement e,
 Domain d)

Returns a nominal descriptor for the supplied argument, presuming it to have originated from the supplied Domain, or an empty Optional if the supplied argument cannot be described.

Parameters:

e - the argument; may be null

d - the Domain from which the argument originated; must not be null

Returns:

a non-null Optional

Throws:

NullPointerException - if d is null

describe

public static final Optional<? extends ConstantDesc> describe(TypeMirror t,
 Domain d)

Returns a nominal descriptor for the supplied argument, presuming it to have originated from the supplied Domain, or an empty Optional if the supplied argument cannot be described.

Parameters:

t - the argument; may be null

d - the Domain from which the argument originated; must not be null

Returns:

a non-null Optional

Throws:

NullPointerException - if d is null

describe

public static final Optional<? extends ConstantDesc> describe(ArrayType t,
 Domain d)

Returns a nominal descriptor for the supplied argument, presuming it to have originated from the supplied Domain, or an empty Optional if the supplied argument cannot be described.

Parameters:

t - the argument; may be null

d - the Domain from which the argument originated; must not be null

Returns:

a non-null Optional

Throws:

NullPointerException - if d is null

describe

public static final Optional<? extends ConstantDesc> describe(DeclaredType t,
 Domain d)

Returns a nominal descriptor for the supplied argument, presuming it to have originated from the supplied Domain, or an empty Optional if the supplied argument cannot be described.

Parameters:

t - the argument; may be null

d - the Domain from which the argument originated; must not be null

Returns:

a non-null Optional

Throws:

NullPointerException - if d is null

describe

public static final Optional<? extends ConstantDesc> describe(NoType t,
 Domain d)

Returns a nominal descriptor for the supplied argument, presuming it to have originated from the supplied Domain, or an empty Optional if the supplied argument cannot be described.

Parameters:

t - the argument; may be null

d - the Domain from which the argument originated; must not be null

Returns:

a non-null Optional

Throws:

NullPointerException - if d is null

describe

public static final Optional<? extends ConstantDesc> describe(NullType t,
 Domain d)

Returns a nominal descriptor for the supplied argument, presuming it to have originated from the supplied Domain, or an empty Optional if the supplied argument cannot be described.

Parameters:

t - the argument; may be null

d - the Domain from which the argument originated; must not be null

Returns:

a non-null Optional

Throws:

NullPointerException - if d is null

describe

public static final Optional<? extends ConstantDesc> describe(PrimitiveType t,
 Domain d)

Returns a nominal descriptor for the supplied argument, presuming it to have originated from the supplied Domain, or an empty Optional if the supplied argument cannot be described.

Parameters:

t - the argument; may be null

d - the Domain from which the argument originated; must not be null

Returns:

a non-null Optional

Throws:

NullPointerException - if d is null

describe

public static final Optional<? extends ConstantDesc> describe(TypeVariable t,
 Domain d)

Returns a nominal descriptor for the supplied argument, presuming it to have originated from the supplied Domain, or an empty Optional if the supplied argument cannot be described.

Parameters:

t - the argument; may be null

d - the Domain from which the argument originated; must not be null

Returns:

a non-null Optional

Throws:

NullPointerException - if d is null

describe

public static final Optional<? extends ConstantDesc> describe(WildcardType t,
 Domain d)

Returns a nominal descriptor for the supplied argument, presuming it to have originated from the supplied Domain, or an empty Optional if the supplied argument cannot be described.

Parameters:

t - the argument; may be null

d - the Domain from which the argument originated; must not be null

Returns:

a non-null Optional

Throws:

NullPointerException - if d is null