Package ch.so.agi.hop.doclint.model

Enum Class PluginType

java.lang.Object

java.lang.Enum<PluginType>

ch.so.agi.hop.doclint.model.PluginType

All Implemented Interfaces:

Serializable, Comparable<PluginType>, Constable

public enum PluginType
extends Enum<PluginType>

Hop plugin element types understood by the linter.

v0.1 scans @Transform only. Action and metadata rules are already modelled so that support can be enabled without changing the validation core.

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
ACTION
METADATA
TRANSFORM

Method Summary

Modifier and Type	Method	Description
String	annotationName()
String	docsSubdirectory()
String	id()
String	label()
List<String>	requiredSections()
static List<PluginType>	scanned()	Types that are currently discovered on the compiled classes.
static PluginType	valueOf(String name)	Returns the enum constant of this class with the specified name.
static PluginType[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

TRANSFORM

public static final PluginType TRANSFORM

ACTION

public static final PluginType ACTION

METADATA

public static final PluginType METADATA

Method Details

values

public static PluginType[] values()

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

Returns:

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

valueOf

public static PluginType valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null

scanned

public static List<PluginType> scanned()

Types that are currently discovered on the compiled classes.

id

public String id()

docsSubdirectory

public String docsSubdirectory()

annotationName

public String annotationName()

requiredSections

public List<String> requiredSections()

label

public String label()