Package org.owasp.csrfguard.config.overlay

Enum ConfigPropertiesCascadeBase.ConfigFileType

java.lang.Object

java.lang.Enum<ConfigPropertiesCascadeBase.ConfigFileType>

org.owasp.csrfguard.config.overlay.ConfigPropertiesCascadeBase.ConfigFileType

All Implemented Interfaces:

Serializable, Comparable<ConfigPropertiesCascadeBase.ConfigFileType>

Enclosing class:

ConfigPropertiesCascadeBase

protected static enum ConfigPropertiesCascadeBase.ConfigFileType
extends Enum<ConfigPropertiesCascadeBase.ConfigFileType>

config file type

Enum Constant Summary

Enum Constants

Enum Constant	Description
CLASSPATH	get a config file from the classpath
FILE	get a config file from the filesystem

Method Summary

Modifier and Type	Method	Description
abstract InputStream	inputStream(String configFileTypeConfig, ConfigPropertiesCascadeBase configPropertiesCascadeBase)	get the inputstream to read the config
static ConfigPropertiesCascadeBase.ConfigFileType	valueOf(String name)	Returns the enum constant of this type with the specified name.
static ConfigPropertiesCascadeBase.ConfigFileType	valueOfIgnoreCase(String string)	do a case-insensitive matching
static ConfigPropertiesCascadeBase.ConfigFileType[]	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

FILE

public static final ConfigPropertiesCascadeBase.ConfigFileType FILE

get a config file from the filesystem

CLASSPATH

public static final ConfigPropertiesCascadeBase.ConfigFileType CLASSPATH

get a config file from the classpath

Method Detail

values

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

Returns:

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

valueOf

public static ConfigPropertiesCascadeBase.ConfigFileType 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

inputStream

public abstract InputStream inputStream(String configFileTypeConfig,
                                        ConfigPropertiesCascadeBase configPropertiesCascadeBase)

get the inputstream to read the config

Parameters:

configFileTypeConfig - The reference to the config file, used either as pathname for a File or a URL

configPropertiesCascadeBase - add the config object in case

Returns:

the input stream to get this config

valueOfIgnoreCase

public static ConfigPropertiesCascadeBase.ConfigFileType valueOfIgnoreCase(String string)

do a case-insensitive matching

Parameters:

string - the config file type

Returns:

the enum or null or exception if not found