Class EnumClassInfo<T extends Enum<T>>

java.lang.Object

ch.njol.skript.classes.ClassInfo<T>

ch.njol.skript.classes.EnumClassInfo<T>

Type Parameters:

T - The enum class.

All Implemented Interfaces:

Debuggable

Direct Known Subclasses:

TeleportFlagClassInfo

public class EnumClassInfo<T extends Enum<T>>
extends ClassInfo<T>

This class can be used for an easier writing of ClassInfos that are enums, it registers a language node with usage, a serializer, default expression and a parser. Making it easier to register enum ClassInfos.

Nested Class Summary

Nested classes/interfaces inherited from class ClassInfo

ClassInfo.PropertyDocs

Field Summary

Fields inherited from class ClassInfo

NO_DOC

Constructor Summary

Constructors

Constructor	Description
EnumClassInfo(Class<T> enumClass, String codeName, String languageNode)
EnumClassInfo(Class<T> enumClass, String codeName, String languageNode, boolean registerComparator)	Deprecated, for removal: This API element is subject to removal in a future version. registerComparator is no longer necessary.
EnumClassInfo(Class<T> enumClass, String codeName, String languageNode, DefaultExpression<T> defaultExpression)
EnumClassInfo(Class<T> enumClass, String codeName, String languageNode, DefaultExpression<T> defaultExpression, boolean registerComparator)	Deprecated, for removal: This API element is subject to removal in a future version. registerComparator is no longer necessary.
EnumClassInfo(Class<T> enumClass, String codeName, String languageNode, DefaultExpression<T> defaultExpression, Consumer<T> parseCallback)
EnumClassInfo(Class<T> enumClass, String codeName, String languageNode, Consumer<T> parseCallback)

Method Summary

Methods inherited from class ClassInfo

after, after, before, before, changer, clone, cloner, defaultExpression, description, documentationId, examples, getAllProperties, getC, getChanger, getCloner, getCodeName, getDefaultExpression, getDescription, getDocName, getDocumentationID, getExamples, getName, getParser, getPropertyDocumentation, getPropertyInfo, getRequiredPlugins, getSerializeAs, getSerializer, getSince, getSupplier, getUsage, getUserInputPatterns, hasDocs, hasProperty, isValidCodeName, matchesUserInput, name, parser, property, requiredPlugins, serializeAs, serializer, since, supplier, supplier, toString, toString, toString, usage, user

Methods inherited from class Object

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

Constructor Details

EnumClassInfo

public EnumClassInfo(Class<T> enumClass,
 String codeName,
 String languageNode)

Parameters:

enumClass - The class

codeName - The name used in patterns

languageNode - The language node of the type

EnumClassInfo

public EnumClassInfo(Class<T> enumClass,
 String codeName,
 String languageNode,
 Consumer<T> parseCallback)

Parameters:

enumClass - The class

codeName - The name used in patterns

languageNode - The language node of the type

parseCallback - A consumer to run on a successful parse.

EnumClassInfo

public EnumClassInfo(Class<T> enumClass,
 String codeName,
 String languageNode,
 DefaultExpression<T> defaultExpression)

Parameters:

enumClass - The class

codeName - The name used in patterns

languageNode - The language node of the type

defaultExpression - The default expression of the type

EnumClassInfo

public EnumClassInfo(Class<T> enumClass,
 String codeName,
 String languageNode,
 DefaultExpression<T> defaultExpression,
 Consumer<T> parseCallback)

Parameters:

enumClass - The class

codeName - The name used in patterns

languageNode - The language node of the type

defaultExpression - The default expression of the type

parseCallback - A consumer to run on a successful parse.

EnumClassInfo

@Deprecated(since="2.16",
            forRemoval=true)
public EnumClassInfo(Class<T> enumClass,
 String codeName,
 String languageNode,
 boolean registerComparator)

Deprecated, for removal: This API element is subject to removal in a future version.

registerComparator is no longer necessary.

Parameters:

enumClass - The class

codeName - The name used in patterns

languageNode - The language node of the type

registerComparator - Whether a default comparator should be registered for this enum's classinfo

EnumClassInfo

@Deprecated(since="2.16",
            forRemoval=true)
public EnumClassInfo(Class<T> enumClass,
 String codeName,
 String languageNode,
 DefaultExpression<T> defaultExpression,
 boolean registerComparator)

Deprecated, for removal: This API element is subject to removal in a future version.

registerComparator is no longer necessary.

Parameters:

enumClass - The class

codeName - The name used in patterns

languageNode - The language node of the type

defaultExpression - The default expression of the type

registerComparator - Whether a default comparator should be registered for this enum's classinfo