Convenience base class for all selectors accessed through ExtendSelector.

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 Bruce Atherton, bruce@callenish.com (Ant)
package phing.types.selectors
version $Id$

 Methods

Creates an exception that indicates the user has generated a loop of data types referencing each other.

circularReference() 
Inherited
inherited_from \DataType::circularReference()
inherited_from \BaseSelector::circularReference()

Check to see whether any DataType we hold references to is included in the Stack (which holds all DataType instances that directly or indirectly reference this instance, including this instance itself).

dieOnCircularReference($stk, \Project $p) 
Inherited

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.

inherited_from \DataType::dieOnCircularReference()
inherited_from \BaseSelector::dieOnCircularReference()

Parameters

$stk

$p

Performs the check for circular references and returns the referenced object.

getCheckedRef($requiredClass, $dataTypeName) 
Inherited
inherited_from \DataType::getCheckedRef()
inherited_from \BaseSelector::getCheckedRef()

Parameters

$requiredClass

$dataTypeName

Return the description for the current data type.

getDescription() 
Inherited
inherited_from \DataType::getDescription()
inherited_from \BaseSelector::getDescription()

Returns any error messages that have been set.

getError() : \the
Inherited
inherited_from \BaseSelector::getError()

Returns

\theerror condition

Returns a reference to current project

getProject() : \Project
Inherited
inherited_from \ProjectComponent::getProject()
inherited_from \DataType::getProject()
inherited_from \BaseSelector::getProject()

Returns

\ProjectReference to current porject object

Has the refid attribute of this element been set?

isReference() 
Inherited
inherited_from \DataType::isReference()
inherited_from \BaseSelector::isReference()

Method that each selector will implement to create their selection behaviour.

isSelected(\PhingFile $basedir, \filename $filename, \PhingFile $file) : \whether
Inherited

If there is a problem with the setup of a selector, it can throw a BuildException to indicate the problem.

inherited_from \FileSelector::isSelected()
inherited_from \BaseSelector::isSelected()

Parameters

$basedir

\basedir

A PhingFile object for the base directory

$filename

\filename

The name of the file to check

$file

\file

A PhingFile object for this filename

Exceptions

\BuildException if the selector was not configured correctly

Returns

\whetherthe file should be selected or not

Logs a message with the given priority.

log(string $msg, integer $level) 
Inherited
inherited_from \ProjectComponent::log()
inherited_from \DataType::log()
inherited_from \BaseSelector::log()

Parameters

$msg

string

The message to be logged.

$level

integer

The message's priority at this message should have

Creates an exception that indicates that this XML element must not have child elements if the refid attribute is set.

noChildrenAllowed() 
Inherited
inherited_from \DataType::noChildrenAllowed()
inherited_from \BaseSelector::noChildrenAllowed()

Template method being called when the data type has been parsed completely.

parsingComplete() : void
Inherited
inherited_from \DataType::parsingComplete()
inherited_from \BaseSelector::parsingComplete()

Sets a description of the current data type.

setDescription($desc) 
Inherited

It will be useful in commenting what we are doing.

inherited_from \DataType::setDescription()
inherited_from \BaseSelector::setDescription()

Parameters

$desc

Allows all selectors to indicate a setup error.

setError(\msg $msg) 
Inherited

Note that only the first error message is recorded.

inherited_from \BaseSelector::setError()

Parameters

$msg

\msg

The error message any BuildException should throw.

Set all the Parameters for this custom selector, collected by the ExtendSelector class.

setParameters(\parameters $parameters) 

Parameters

$parameters

\parameters

the complete set of parameters for this selector

References the project to the current component.

setProject(\Project $project) 
Inherited
inherited_from \ProjectComponent::setProject()
inherited_from \DataType::setProject()
inherited_from \BaseSelector::setProject()

Parameters

$project

\Project

The reference to the current project

Set the value of the refid attribute.

setRefid(\Reference $r) : void
Inherited

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()

inherited_from \DataType::setRefid()
inherited_from \BaseSelector::setRefid()

Parameters

Creates an exception that indicates that refid has to be the only attribute if it is set.

tooManyAttributes() 
Inherited
inherited_from \DataType::tooManyAttributes()
inherited_from \BaseSelector::tooManyAttributes()

Subclasses can use this to throw the requisite exception in isSelected() in the case of an error condition.

validate() 
Inherited
inherited_from \BaseSelector::validate()

<p>Subclasses can override this method to provide checking of their state.

verifySettings() 
Inherited

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.

inherited_from \BaseSelector::verifySettings()

Allows access to the parameters gathered and set within the &lt;custom&gt; tag.

getParameters() : \the

Returns

\theset of parameters defined for this selector

 Properties

 

$description 
Inherited
inherited_from \DataType::$$description
inherited_from \BaseSelector::$$description
 

$ref 
Inherited

Type of Reference

inherited_from \DataType::$$ref
inherited_from \BaseSelector::$$ref
 

$checked : boolean
Inherited

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).

inherited_from \DataType::$$checked
inherited_from \BaseSelector::$$checked
 

$parameters 
 

$project : \Project
Inherited
inherited_from \ProjectComponent::$$project
inherited_from \DataType::$$project
inherited_from \BaseSelector::$$project
 

$errmsg 
Inherited
inherited_from \BaseSelector::$$errmsg