public abstract class BaseSelector extends DataType implements FileSelector
description, location, project
Constructor and Description |
---|
BaseSelector()
Do nothing constructor.
|
Modifier and Type | Method and Description |
---|---|
java.lang.String |
getError()
Returns any error messages that have been set.
|
abstract boolean |
isSelected(java.io.File basedir,
java.lang.String filename,
java.io.File file)
Method that each selector will implement to create their
selection behaviour.
|
void |
setError(java.lang.String msg)
Allows all selectors to indicate a setup error.
|
void |
setError(java.lang.String msg,
java.lang.Throwable cause)
Allows all selectors to indicate a setup error.
|
void |
validate()
Subclasses can use this to throw the requisite exception
in isSelected() in the case of an error condition.
|
void |
verifySettings()
Subclasses can override this method to provide checking of their
state.
|
checkAttributesAllowed, checkChildrenAllowed, circularReference, clone, dieOnCircularReference, dieOnCircularReference, dieOnCircularReference, getCheckedRef, getCheckedRef, getCheckedRef, getCheckedRef, getDataTypeName, getRefid, invokeCircularReferenceCheck, isChecked, isReference, noChildrenAllowed, pushAndInvokeCircularReferenceCheck, setChecked, setRefid, tooManyAttributes, toString
getDescription, getLocation, getProject, log, log, setDescription, setLocation, setProject
public void setError(java.lang.String msg)
msg
- The error message any BuildException should throw.public void setError(java.lang.String msg, java.lang.Throwable cause)
msg
- The error message any BuildException should throw.cause
- Throwablepublic java.lang.String getError()
public void verifySettings()
Subclasses can override this method to provide checking of their state. So long as they call validate() from isSelected(), this will be called automatically (unless they override validate()).
Implementations should check for incorrect settings and call setError() as necessary.
public void validate()
public abstract boolean isSelected(java.io.File basedir, java.lang.String filename, java.io.File file)
isSelected
in interface FileSelector
basedir
- A java.io.File object for the base directoryfilename
- The name of the file to checkfile
- A File object for this filename