| 
 | ||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Object
  |
  +--org.apache.tools.ant.ProjectComponent
        |
        +--org.apache.tools.ant.types.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>).
| Field Summary | |
| protected  boolean | checkedDeprecated. The user should not be directly referencing variable. Please use setChecked(boolean)orisChecked()instead. | 
| protected  java.lang.String | descriptionDeprecated. The user should not be directly referencing variable. Please use setDescription(java.lang.String)orgetDescription()instead. | 
| protected  Reference | refDeprecated. The user should not be directly referencing variable. Please use getRefid()instead. | 
| Fields inherited from class org.apache.tools.ant.ProjectComponent | 
| project | 
| Constructor Summary | |
| DataType() | |
| 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(java.util.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  java.lang.Object | getCheckedRef(java.lang.Class requiredClass,
              java.lang.String dataTypeName)Performs the check for circular references and returns the referenced object. | 
|  java.lang.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(java.lang.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. | 
| Methods inherited from class org.apache.tools.ant.ProjectComponent | 
| getProject, log, log, setProject | 
| Methods inherited from class java.lang.Object | 
| clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait | 
| Field Detail | 
protected java.lang.String description
setDescription(java.lang.String) or
   getDescription() instead.
protected Reference ref
getRefid() instead.
protected boolean checked
setChecked(boolean) or
   isChecked() instead.
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).
| Constructor Detail | 
public DataType()
| Method Detail | 
public void setDescription(java.lang.String desc)
public java.lang.String getDescription()
public boolean isReference()
public void setRefid(Reference ref)
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.
protected void dieOnCircularReference(java.util.Stack stack,
                                      Project project)
                               throws BuildException
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
BuildException
protected java.lang.Object getCheckedRef(java.lang.Class requiredClass,
                                         java.lang.String dataTypeName)
protected BuildException tooManyAttributes()
protected BuildException noChildrenAllowed()
protected BuildException circularReference()
protected boolean isChecked()
protected void setChecked(boolean checked)
protected Reference getRefid()
protected void checkAttributesAllowed()
BuildException - if not allowedprotected void checkChildrenAllowed()
BuildException - if not allowed| 
 | ||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||