org.apache.juneau.config

Enum ConfigMod

java.lang.Object

java.lang.Enum<ConfigMod>

org.apache.juneau.config.ConfigMod

All Implemented Interfaces:

Serializable, Comparable<ConfigMod>

public enum ConfigMod
extends Enum<ConfigMod>

Identifies the supported modification types for config entries.

Enum Constant Summary

Enum Constants

Enum Constant and Description
ENCODED Encoded using the registered ConfigEncoder.

Method Summary

Modifier and Type	Method and Description
static List<ConfigMod>	asModifiers(String s) Converts a modifier string (e.g.
static List<ConfigMod>	asModifiersReverse(String s) Converts a modifier string (e.g.
static String	asString(ConfigMod... mods) Converts an array of modifiers to a modifier string.
static ConfigMod	valueOf(String name) Returns the enum constant of this type with the specified name.
static ConfigMod[]	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

ENCODED

public static final ConfigMod ENCODED

Encoded using the registered ConfigEncoder.

Method Detail

values

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

Returns:

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

valueOf

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

asString

public static String asString(ConfigMod... mods)

Converts an array of modifiers to a modifier string.

Parameters:

mods - The modifiers.

Returns:

A modifier string, or an empty string if there are no modifiers.

asModifiersReverse

public static List<ConfigMod> asModifiersReverse(String s)

Converts a modifier string (e.g. "^*") into a list of Modifiers in reverse order of how they appear in the string.

Parameters:

s - The modifier string.

Returns:

The list of modifiers, or an empty list if the string is empty or null.

asModifiers

public static List<ConfigMod> asModifiers(String s)

Converts a modifier string (e.g. "^*") into a list of Modifiers.

Parameters:

s - The modifier string.

Returns:

The list of modifiers, or an empty list if the string is empty or null.