com.github.mkolisnyk.sirius.client

Enum ConfigurationOption

java.lang.Object

java.lang.Enum<ConfigurationOption>

com.github.mkolisnyk.sirius.client.ConfigurationOption

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<ConfigurationOption>

public enum ConfigurationOption
extends java.lang.Enum<ConfigurationOption>

Some configuration options are frequently used and have fixed predefined names. The purpose of this enumeration is to collect the most commonly used configuration option names.

Author:

Mykola Kolisnyk

See Also:

Configuration

Enum Constant Summary

Enum Constants

Enum Constant and Description
PAGES_PACKAGE
PLATFORM
TIMEOUT

Method Summary

Modifier and Type	Method and Description
static ConfigurationOption	fromString(java.lang.String input) Converts string into ConfigurationOption value.
java.lang.String	getValue() Gets the string value associated with the constant.
java.lang.String	toString()
static ConfigurationOption	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static ConfigurationOption[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, equals, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

PLATFORM

public static final ConfigurationOption PLATFORM

TIMEOUT

public static final ConfigurationOption TIMEOUT

PAGES_PACKAGE

public static final ConfigurationOption PAGES_PACKAGE

Method Detail

values

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

Returns:

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

valueOf

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

fromString

public static ConfigurationOption fromString(java.lang.String input)

Converts string into ConfigurationOption value. If corresponding option wasn't found the null value is returned.

Parameters:

input - the configuration option name represented as the string.

Returns:

the ConfigurationOption value corresponding to the input parameter.

getValue

public java.lang.String getValue()

Gets the string value associated with the constant.

Returns:

the string value associated with the constant.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Enum<ConfigurationOption>