org.apache.tools.ant.types
public abstract class DataType extends ProjectComponent
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>).
Field Summary | |
---|---|
protected boolean | checked
Are we sure we don't hold circular references?
|
protected String | description
The description the user has set.
|
protected Reference | ref
Value to the refid attribute.
|
Method Summary | |
---|---|
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. |
Deprecated: The user should not be directly referencing variable. Please use {@link #setChecked} or {@link #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).
Deprecated: The user should not be directly referencing variable. Please use {@link #setDescription} or {@link #getDescription} instead.
The description the user has set.Deprecated: The user should not be directly referencing variable. Please use {@link #getRefid} instead.
Value to the refid attribute.Throws: BuildException if not allowed
Since: Ant 1.6
Throws: BuildException if not allowed
Since: Ant 1.6
If one is included, throw a BuildException created by {@link #circularReference 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 {@link #checked checked
} is true and
set it to true on exit.
Returns: the reference or null
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
.