net.officefloor.plugin.servlet.filter.configuration

Class FilterInstance

java.lang.Object

net.officefloor.plugin.servlet.filter.configuration.FilterInstance

public class FilterInstance
extends Object

Configuration of a Filter instance.

Author:

Daniel Sagenschneider

Constructor Summary

Constructors

Constructor and Description
FilterInstance(String name) Initiate.
FilterInstance(String name, String className, String... initParameterNameValues) Convenience constructor to fully initialise.

Method Summary

Modifier and Type	Method and Description
void	addInitParameter(String name, String value) Adds an init parameter.
String	getClassName() Obtains the Class name of the Filter.
Map<String,String>	getInitParameters() Obtains the init parameters for the Filter.
String	getName() Obtains the name of the Filter.
void	inputProperties(PropertyList properties) Input the Property instances.
static FilterInstance[]	loadFilterInstances(PropertyList properties) Loads the FilterInstance instances from the PropertyList.
void	outputProperties(PropertyList properties) Output the Property instances.
void	setClassName(String className) Specifies the Class name of the Filter.
void	setName(String name) Specifies the name of the Filter.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FilterInstance

public FilterInstance(String name)

Initiate.

Parameters:

name - Name of the Filter.

FilterInstance

public FilterInstance(String name,
                      String className,
                      String... initParameterNameValues)

Convenience constructor to fully initialise.

Parameters:

name - Name of the Filter.

className - Filter class name.

initParameterNameValues - Init parameters for the Filter.

Method Detail

loadFilterInstances

public static FilterInstance[] loadFilterInstances(PropertyList properties)

Loads the FilterInstance instances from the PropertyList.

Parameters:

properties - PropertyList.

Returns:

FilterInstance instances.

getName

public String getName()

Obtains the name of the Filter.

Returns:

Name of the Filter.

setName

public void setName(String name)

Specifies the name of the Filter.

Parameters:

name - Name of the Filter.

getClassName

public String getClassName()

Obtains the Class name of the Filter.

Returns:

Class name of the Filter.

setClassName

public void setClassName(String className)

Specifies the Class name of the Filter.

Parameters:

className - Class name of the Filter.

addInitParameter

public void addInitParameter(String name,
                             String value)

Adds an init parameter.

Parameters:

name - Name.

value - Value.

getInitParameters

public Map<String,String> getInitParameters()

Obtains the init parameters for the Filter.

Returns:

Init parameters for the Filter.

outputProperties

public void outputProperties(PropertyList properties)

Output the Property instances.

Parameters:

properties - PropertyList to output Property instances.

inputProperties

public void inputProperties(PropertyList properties)

Input the Property instances.

Parameters:

properties - PropertyList to input Property instances.