org.apache.tools.ant.types
Class DataType
public abstract class DataType
Base class for those classes that can appear inside the build file
as stand alone data types.
This class handles the common description attribute and provides
a default implementation for reference handling and checking for
circular references that is appropriate for types that can not be
nested inside elements of the same type (i.e. <patternset>
but not <path>).
protected boolean | checked - The user should not be directly referencing
variable.
|
protected String | description - The user should not be directly referencing
variable.
|
protected Reference | ref - The user should not be directly referencing
variable.
|
protected void | checkAttributesAllowed() - check that it is ok to set attributes, i.e that no reference is defined
|
protected void | checkChildrenAllowed() - check that it is ok to add children, i.e that no reference is defined
|
protected BuildException | circularReference() - Creates an exception that indicates the user has generated a
loop of data types referencing each other.
|
protected void | dieOnCircularReference(Stack stack, Project project) - 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).
|
protected Object | getCheckedRef(Class requiredClass, String dataTypeName) - Performs the check for circular references and returns the
referenced object.
|
String | getDescription() - Return the description for the current data type.
|
protected Reference | getRefid() - get the reference set on this object
|
protected boolean | isChecked()
|
boolean | isReference() - Has the refid attribute of this element been set?
|
protected BuildException | noChildrenAllowed() - Creates an exception that indicates that this XML element must
not have child elements if the refid attribute is set.
|
protected void | setChecked(boolean checked)
|
void | setDescription(String desc) - Sets a description of the current data type.
|
void | setRefid(Reference ref) - Set the value of the refid attribute.
|
protected BuildException | tooManyAttributes() - Creates an exception that indicates that refid has to be the
only attribute if it is set.
|
checked
protected boolean checked
The user should not be directly referencing
variable. Please use setChecked(boolean)
or
isChecked()
instead.
Are we sure we don't hold circular references?
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).
ref
protected Reference ref
The user should not be directly referencing
variable. Please use getRefid()
instead.
Value to the refid attribute.
checkAttributesAllowed
protected void checkAttributesAllowed()
check that it is ok to set attributes, i.e that no reference is defined
checkChildrenAllowed
protected void checkChildrenAllowed()
check that it is ok to add children, i.e that no reference is defined
circularReference
protected BuildException circularReference()
Creates an exception that indicates the user has generated a
loop of data types referencing each other.
dieOnCircularReference
protected void dieOnCircularReference(Stack stack,
Project project)
throws BuildException
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).
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
protected Object getCheckedRef(Class requiredClass,
String dataTypeName)
Performs the check for circular references and returns the
referenced object.
getDescription
public String getDescription()
Return the description for the current data type.
getRefid
protected Reference getRefid()
get the reference set on this object
isChecked
protected boolean isChecked()
isReference
public boolean isReference()
Has the refid attribute of this element been set?
noChildrenAllowed
protected BuildException noChildrenAllowed()
Creates an exception that indicates that this XML element must
not have child elements if the refid attribute is set.
setChecked
protected void setChecked(boolean checked)
setDescription
public void setDescription(String desc)
Sets a description of the current data type. It will be useful
in commenting what we are doing.
setRefid
public void setRefid(Reference ref)
Set the value of the refid attribute.
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 the must call
super.setRefid
.
tooManyAttributes
protected BuildException tooManyAttributes()
Creates an exception that indicates that refid has to be the
only attribute if it is set.
Copyright B) 2000-2008 Apache Software Foundation. All Rights Reserved.