Package com.mrivanplays.annotationconfig.core.annotations.type

Enum AnnotationType

java.lang.Object

java.lang.Enum<AnnotationType>

com.mrivanplays.annotationconfig.core.annotations.type.AnnotationType

All Implemented Interfaces:

Serializable, Comparable<AnnotationType>, java.lang.constant.Constable

public enum AnnotationType
extends Enum<AnnotationType>

Represents an annotation type, holding utility methods for the held raw annotation type.

Author:

MrIvanPlays

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
COMMENT
COMMENTS
CONFIG_OBJECT
IGNORE
KEY
MAX
MIN

Method Summary

Modifier and Type	Method	Description
Class<? extends Annotation>	getRawType()	Returns the raw annotation type, held by this AnnotationType
boolean	is(AnnotationType type)
boolean	is(Class<? extends Annotation> anno)	Returns if the raw annotation type specified meets this AnnotationType
static Optional<AnnotationType>	match(Class<? extends Annotation> annotationType)	Returns an Optional value, which may contain the AnnotationType matched to the specified .
String	toString()
static AnnotationType	valueOf(String name)	Returns the enum constant of this type with the specified name.
static AnnotationType[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

COMMENT

public static final AnnotationType COMMENT

COMMENTS

public static final AnnotationType COMMENTS

KEY

public static final AnnotationType KEY

CONFIG_OBJECT

public static final AnnotationType CONFIG_OBJECT

IGNORE

public static final AnnotationType IGNORE

MAX

public static final AnnotationType MAX

MIN

public static final AnnotationType MIN

Method Details

values

public static AnnotationType[] values()

Returns an array containing the constants of this enum type, in the order they are declared.

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static AnnotationType valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

match

public static Optional<AnnotationType> match(Class<? extends Annotation> annotationType)

Returns an Optional value, which may contain the AnnotationType matched to the specified .

Parameters:

annotationType - the annotation type wanted

Returns:

annotation type or an empty optional

getRawType

public Class<? extends Annotation> getRawType()

Returns the raw annotation type, held by this AnnotationType

Returns:

raw annotation class

is

public boolean is(Class<? extends Annotation> anno)

Returns if the raw annotation type specified meets this AnnotationType

Parameters:

anno - the raw annotation type you want to check

Returns:

boolean value, representing the outcome of this check

is

public boolean is(AnnotationType type)

Parameters:

type - annotation type

Returns:

boolean value, representing the outcome of this check

See Also:

• is(Class)

toString

public String toString()

Overrides:

toString in class Enum<AnnotationType>