com.flexive.shared.configuration
Enum SystemParameterPaths

java.lang.Object
  extended by java.lang.Enum<SystemParameterPaths>
      extended by com.flexive.shared.configuration.SystemParameterPaths
All Implemented Interfaces:
ParameterPath, java.io.Serializable, java.lang.Comparable<SystemParameterPaths>

public enum SystemParameterPaths
extends java.lang.Enum<SystemParameterPaths>
implements ParameterPath

Enumeration holding valid parameter paths. Each parameter path has an associated scope (e.g. global, division, user, with/without fallbacks).

Author:
Daniel Lichtenberger (daniel.lichtenberger@flexive.com), UCS - unique computing solutions gmbh (http://www.ucs.at)

Enum Constant Summary
APPLICATION_CONFIG
          Generic application configuration
DIVISION_CONFIG
          generic division specific parameters
DIVISION_RUNONCE_CONFIG
          Path for storing division specific stuff
DIVISION_TREE
          Global tree config path
GLOBAL_CONFIG
          Global configuration root path
GLOBAL_DIVISIONS_DOMAINS
          Path for storing the domain name matchers per division
GLOBAL_DIVISIONS_DS
          Path for storing the datasources per division
NODE_CONFIG
          Node specific configuration
TEST_APPLICATION
          unit test entry
TEST_APPLICATION_ONLY
          unit test entry
TEST_DIVISION
          unit test entry
TEST_DIVISION_ONLY
          unit test entry
TEST_GLOBAL
          unit test entry
TEST_NODE
          unit test entry
TEST_NODE_ONLY
          unit test entry
TEST_USER
          unit test entry
TEST_USER_ONLY
          unit test entry
USER_CONFIG
          Miscellaneous user preferences
USER_CONFIG_ONLY
           
USER_QUERIES_CONTENT
          Path for storing user search queries
USER_RESULT_PREFERENCES
          Search result preferences
 
Method Summary
 ParameterScope getScope()
          Returns the scope of the configuration path
static java.util.List<SystemParameterPaths> getTestPaths()
          Return test path entries used for unit testing.
 java.lang.String getValue()
          Returns the contained configuration path.
 java.lang.String toString()
          
static SystemParameterPaths valueOf(java.lang.String name)
          Returns the enum constant of this type with the specified name.
static SystemParameterPaths[] 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

GLOBAL_CONFIG

public static final SystemParameterPaths GLOBAL_CONFIG
Global configuration root path


GLOBAL_DIVISIONS_DS

public static final SystemParameterPaths GLOBAL_DIVISIONS_DS
Path for storing the datasources per division


GLOBAL_DIVISIONS_DOMAINS

public static final SystemParameterPaths GLOBAL_DIVISIONS_DOMAINS
Path for storing the domain name matchers per division


DIVISION_TREE

public static final SystemParameterPaths DIVISION_TREE
Global tree config path


DIVISION_RUNONCE_CONFIG

public static final SystemParameterPaths DIVISION_RUNONCE_CONFIG
Path for storing division specific stuff


DIVISION_CONFIG

public static final SystemParameterPaths DIVISION_CONFIG
generic division specific parameters


APPLICATION_CONFIG

public static final SystemParameterPaths APPLICATION_CONFIG
Generic application configuration


USER_QUERIES_CONTENT

public static final SystemParameterPaths USER_QUERIES_CONTENT
Path for storing user search queries


USER_RESULT_PREFERENCES

public static final SystemParameterPaths USER_RESULT_PREFERENCES
Search result preferences


USER_CONFIG

public static final SystemParameterPaths USER_CONFIG
Miscellaneous user preferences


USER_CONFIG_ONLY

public static final SystemParameterPaths USER_CONFIG_ONLY

NODE_CONFIG

public static final SystemParameterPaths NODE_CONFIG
Node specific configuration


TEST_GLOBAL

public static final SystemParameterPaths TEST_GLOBAL
unit test entry


TEST_DIVISION

public static final SystemParameterPaths TEST_DIVISION
unit test entry


TEST_DIVISION_ONLY

public static final SystemParameterPaths TEST_DIVISION_ONLY
unit test entry


TEST_USER

public static final SystemParameterPaths TEST_USER
unit test entry


TEST_USER_ONLY

public static final SystemParameterPaths TEST_USER_ONLY
unit test entry


TEST_APPLICATION

public static final SystemParameterPaths TEST_APPLICATION
unit test entry


TEST_APPLICATION_ONLY

public static final SystemParameterPaths TEST_APPLICATION_ONLY
unit test entry


TEST_NODE

public static final SystemParameterPaths TEST_NODE
unit test entry


TEST_NODE_ONLY

public static final SystemParameterPaths TEST_NODE_ONLY
unit test entry

Method Detail

values

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

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

valueOf

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

getValue

public java.lang.String getValue()
Returns the contained configuration path.

Specified by:
getValue in interface ParameterPath
Returns:
configuration path

getScope

public ParameterScope getScope()
Returns the scope of the configuration path

Specified by:
getScope in interface ParameterPath
Returns:
the scope of the configuration path

getTestPaths

public static java.util.List<SystemParameterPaths> getTestPaths()
Return test path entries used for unit testing.

Returns:
test path entries used for unit testing.

toString

public java.lang.String toString()

Overrides:
toString in class java.lang.Enum<SystemParameterPaths>