Package com.planet_ink.coffee_mud.Libraries.interfaces

Enum HelpLibrary.HelpSection

java.lang.Object

java.lang.Enum<HelpLibrary.HelpSection>

com.planet_ink.coffee_mud.Libraries.interfaces.HelpLibrary.HelpSection

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<HelpLibrary.HelpSection>

Enclosing interface:

HelpLibrary

public static enum HelpLibrary.HelpSection
extends java.lang.Enum<HelpLibrary.HelpSection>

An enum for how to search help files.

Enum Constant Summary

Enum Constants

Enum Constant	Description
ArchonFirst
ArchonOnly
NormalFirst
NormalOnly

Method Summary

Modifier and Type	Method	Description
static HelpLibrary.HelpSection	valueOf(java.lang.String name)	Returns the enum constant of this type with the specified name.
static HelpLibrary.HelpSection[]	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, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

ArchonOnly

public static final HelpLibrary.HelpSection ArchonOnly

NormalOnly

public static final HelpLibrary.HelpSection NormalOnly

ArchonFirst

public static final HelpLibrary.HelpSection ArchonFirst

NormalFirst

public static final HelpLibrary.HelpSection NormalFirst

Method Detail

values

public static HelpLibrary.HelpSection[] 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 (HelpLibrary.HelpSection c : HelpLibrary.HelpSection.values())
    System.out.println(c);

Returns:

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

valueOf

public static HelpLibrary.HelpSection valueOf(java.lang.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:

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

java.lang.NullPointerException - if the argument is null