Selector that selects a certain kind of file: directory or regular file.
It provides support for gathering the parameters together as well as for assigning an error message and throwing a build exception if an error is detected.
author |
Hans Lellelid hans@xmpl.org (Phing) |
---|---|
author |
Jeff Turner jefft@apache.org (Ant) |
version |
$Id: 95c34bb6a364dc0131e9e9c5c124d5074b4a2a21 $ |
package |
phing.types.selectors |
toString() : string
string
A string describing this object
setType(string $type)
string
The type of file - 'file' or 'dir'
setParameters($parameters)
verifySettings()
isSelected(\PhingFile $basedir, string $filename, \PhingFile $file) : boolean
string
is the name of the file to check
boolean
Whether the file should be selected or not
getParameters() : \the
\the
set of parameters defined for this selector
setError($msg)
getError() : \the
\the
error condition
validate()
setDescription($desc)
getDescription()
isReference()
setRefid(\Reference $r) : void
Subclasses may need to check whether any other attributes have been set as well or child elements have been created and thus override this method. if they do they must call parent::setRefid()
dieOnCircularReference($stk, \Project $p)
If one is included, throw a BuildException created by circularReference
This implementation is appropriate only for a DataType that cannot hold other DataTypes as children.
The general contract of this method is that it shouldn't do anything if checked is true and set it to true on exit.
getCheckedRef($requiredClass, $dataTypeName)
tooManyAttributes()
noChildrenAllowed()
circularReference()
parsingComplete() : void
setProject(\Project $project)
getProject() : \Project
log(string $msg, integer $level = \Project::MSG_INFO)
string
The message to be logged.
integer
The message's priority at this message should have
TYPE_KEY
type :
types :
parameters :
errmsg :
description :
ref :
checked : boolean
Subclasses are responsible for setting this value to false if we'd need to investigate this condition (usually because a child element has been added that is a subclass of DataType).
var |
---|
boolean
project : \Project