org.graylog2.plugin

Enum DocsHelper

java.lang.Object

java.lang.Enum<DocsHelper>

org.graylog2.plugin.DocsHelper

All Implemented Interfaces:

Serializable, Comparable<DocsHelper>

public enum DocsHelper
extends Enum<DocsHelper>

Enum Constant Summary

Enum Constants

Enum Constant and Description
PAGE_ES_CONFIGURATION
PAGE_LDAP_TROUBLESHOOTING
PAGE_SENDING_JSONPATH

Method Summary

Modifier and Type	Method and Description
String	toLink(String title)
String	toString()
static DocsHelper	valueOf(String name) Returns the enum constant of this type with the specified name.
static DocsHelper[]	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, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

PAGE_SENDING_JSONPATH

public static final DocsHelper PAGE_SENDING_JSONPATH

PAGE_ES_CONFIGURATION

public static final DocsHelper PAGE_ES_CONFIGURATION

PAGE_LDAP_TROUBLESHOOTING

public static final DocsHelper PAGE_LDAP_TROUBLESHOOTING

Method Detail

values

public static DocsHelper[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (DocsHelper c : DocsHelper.values())
    System.out.println(c);

Returns:

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

valueOf

public static DocsHelper 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

toString

public String toString()

Overrides:

toString in class Enum<DocsHelper>

toLink

public String toLink(String title)