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 <E> Optional<? extends ConstantDesc>	describe(List<? extends E> list, Function<? super E, ? extends Optional<? extends ConstantDesc>> f)	Returns a nominal descriptor for the supplied List, or an empty Optional if the supplied List cannot be described.
static <K,V> Optional<? extends ConstantDesc>	describe(Map<? extends K, ? extends V> map, Function<? super K, ? extends Optional<? extends ConstantDesc>> kf, Function<? super V, ? extends Optional<? extends ConstantDesc>> vf)	Returns a nominal descriptor for the supplied Map, or an empty Optional if the supplied Map cannot be described.
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 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

describe

public static final <E>
Optional<? extends ConstantDesc> describe(List<? extends E> list,
 Function<? super E, ? extends Optional<? extends ConstantDesc>> f)

Returns a nominal descriptor for the supplied List, or an empty Optional if the supplied List cannot be described.

Type Parameters:

E - the supplied list's element type

Parameters:

list - a List to be described; may be null; if non-null must be immutable and must not contain null elements or undefined behavior will result

f - a Function that accepts an element from the supplied list and returns a non-null Optional housing a nominal descriptor for it, or a non-null empty Optional if the element cannot be described; must not be null

Returns:

a non-null Optional

Throws:

NullPointerException - if f is null and needs to be used

See Also:

• List.of(Object...)

describe

public static <K,V>
Optional<? extends ConstantDesc> describe(Map<? extends K, ? extends V> map,
 Function<? super K, ? extends Optional<? extends ConstantDesc>> kf,
 Function<? super V, ? extends Optional<? extends ConstantDesc>> vf)

Returns a nominal descriptor for the supplied Map, or an empty Optional if the supplied Map cannot be described.

Type Parameters:

K - the supplied map's key type

V - the supplied map's value type

Parameters:

map - a Map to be described; may be null; if non-null must be immutable and must not contain null keys or values or undefined behavior will result

kf - a Function that accepts a key from the supplied map and returns a non-null Optional housing a nominal descriptor for it, or a non-null empty Optional if the key cannot be described; must not be null

vf - a Function that accepts a value from the supplied map and returns a non-null Optional housing a nominal descriptor for it, or a non-null empty Optional if the value cannot be described; must not be null

Returns:

a non-null Optional

Throws:

NullPointerException - if kf or vf is null and needs to be used

See Also:

• Map.of(Object, Object)