com.izforge.izpack.util.file.types.selectors

Class ContainsRegexpSelector

java.lang.Object

com.izforge.izpack.util.file.types.DataType

com.izforge.izpack.util.file.types.selectors.BaseSelector

com.izforge.izpack.util.file.types.selectors.BaseExtendSelector

com.izforge.izpack.util.file.types.selectors.ContainsRegexpSelector

All Implemented Interfaces:

Parameterizable, ExtendFileSelector, FileSelector

public class ContainsRegexpSelector
extends BaseExtendSelector

Selector that filters files based on a regular expression.

Field Summary

Fields

Modifier and Type	Field and Description
static String	EXPRESSION_KEY Key to used for parameterized custom selector

Fields inherited from class com.izforge.izpack.util.file.types.selectors.BaseExtendSelector

parameters

Constructor Summary

Constructors

Constructor and Description
ContainsRegexpSelector() Creates a new ContainsRegexpSelector instance.

Method Summary

Modifier and Type	Method and Description
boolean	isSelected(InstallData idata, File basedir, String filename, File file) Tests a regular expression against each line of text in the file.
void	setExpression(String theexpression) The regular expression used to search the file.
void	setParameters(Parameter[] parameters) When using this as a custom selector, this method will be called.
String	toString()
void	verifySettings() Checks that an expression was specified.

Methods inherited from class com.izforge.izpack.util.file.types.selectors.BaseExtendSelector

getParameters

Methods inherited from class com.izforge.izpack.util.file.types.selectors.BaseSelector

getError, setError, validate

Methods inherited from class com.izforge.izpack.util.file.types.DataType

getDescription, isChecked, noChildrenAllowed, setChecked, setDescription, tooManyAttributes

Methods inherited from class java.lang.Object

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

Field Detail

EXPRESSION_KEY

public static final String EXPRESSION_KEY

Key to used for parameterized custom selector

See Also:

Constant Field Values

Constructor Detail

ContainsRegexpSelector

public ContainsRegexpSelector()

Creates a new ContainsRegexpSelector instance.

Method Detail

toString

public String toString()

Overrides:

toString in class Object

Returns:

a string describing this object

setExpression

public void setExpression(String theexpression)

The regular expression used to search the file.

Parameters:

theexpression - this must match a line in the file to be selected.

setParameters

public void setParameters(Parameter[] parameters)

When using this as a custom selector, this method will be called. It translates each parameter into the appropriate setXXX() call.

Specified by:

setParameters in interface Parameterizable

Overrides:

setParameters in class BaseExtendSelector

Parameters:

parameters - the complete set of parameters for this selector

verifySettings

public void verifySettings()

Checks that an expression was specified.

Overrides:

verifySettings in class BaseSelector

isSelected

public boolean isSelected(InstallData idata,
                          File basedir,
                          String filename,
                          File file)
                   throws Exception

Tests a regular expression against each line of text in the file.

Specified by:

isSelected in interface FileSelector

Specified by:

isSelected in class BaseExtendSelector

Parameters:

basedir - the base directory the scan is being done from

filename - is the name of the file to check

file - is a java.io.File object the selector can use

Returns:

whether the file should be selected or not

Throws:

Exception - if the selector was not configured correctly