Class EnumValuesFinder

java.lang.Object

nl.pim16aap2.util.reflection.ReflectionFinder<Object[], EnumValuesFinder>

nl.pim16aap2.util.reflection.EnumValuesFinder

public class EnumValuesFinder
extends ReflectionFinder<Object[], EnumValuesFinder>

Represents a ReflectionFinder for enum values.

This class can be used to retrieve enum values.

Calls should be chained, as the instance can change between invocations of some methods.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	EnumValuesFinder.EnumFieldFinderFactory	Factory for EnumValuesFinder objects.
static final class	EnumValuesFinder.IndexedEnumValueFinder	Represents an implementation of ReflectionFinder to retrieve an enum value by its index.
static final class	EnumValuesFinder.NamedEnumValueFinder	Represents an implementation of ReflectionFinder to retrieve an enum value by its name.

Nested classes/interfaces inherited from class ReflectionFinder

ReflectionFinder.ReflectionFinderWithParameters<T,U>

Field Summary

Fields inherited from class ReflectionFinder

modifiers

Constructor Summary

Constructors

Constructor	Description
EnumValuesFinder(Class<?> source)

Method Summary

Modifier and Type	Method	Description
EnumValuesFinder.IndexedEnumValueFinder	atIndex(int index)	Creates a new EnumValuesFinder.IndexedEnumValueFinder to retrieve the enum value by its index.
Object[]	get()	Retrieves the target reflection object(s) using the current configuration.
Object[]	getNullable()	Retrieves the target reflection object(s) using the current configuration.
EnumValuesFinder.NamedEnumValueFinder	withName(String name)	Creates a new EnumValuesFinder.NamedEnumValueFinder to retrieve the enum value by its name.

Methods inherited from class ReflectionFinder

addModifiers, withModifiers

Methods inherited from class Object

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

Constructor Details

EnumValuesFinder

public EnumValuesFinder(Class<?> source)

Method Details

withName

@CheckReturnValue
@Contract(pure=true)
public EnumValuesFinder.NamedEnumValueFinder withName(String name)

Creates a new EnumValuesFinder.NamedEnumValueFinder to retrieve the enum value by its name.

Parameters:

name - The name of the enum value to look for.

Returns:

The new EnumValuesFinder.NamedEnumValueFinder.

atIndex

@CheckReturnValue
@Contract(pure=true)
public EnumValuesFinder.IndexedEnumValueFinder atIndex(int index)

Creates a new EnumValuesFinder.IndexedEnumValueFinder to retrieve the enum value by its index.

Parameters:

index - The index of the enum value to look for.

Returns:

The new EnumValuesFinder.IndexedEnumValueFinder.

get

public Object[] get()

Retrieves the target reflection object(s) using the current configuration.

This may throw an exception if the lookup hasn't been configured yet.

Specified by:

get in class ReflectionFinder<Object[], EnumValuesFinder>

Returns:

The target reflection object(s) being searched for.

Throws:

IllegalStateException - When the source class is not an enum.

getNullable

public Object[] getNullable()

Retrieves the target reflection object(s) using the current configuration.

This may throw an exception if the lookup hasn't been configured yet.

Specified by:

getNullable in class ReflectionFinder<Object[], EnumValuesFinder>

Returns:

The target reflection object(s) being searched for or null if no object(s) could be found.

Throws:

IllegalStateException - When the source class is not an enum.