org.apache.tools.ant.types
Class Description

java.lang.Object
  |
  +--org.apache.tools.ant.ProjectComponent
        |
        +--org.apache.tools.ant.types.DataType
              |
              +--org.apache.tools.ant.types.Description

public class Description
extends DataType

Description is used to provide a project-wide description element (that is, a description that applies to a buildfile as a whole). If present, the <description> element is printed out before the target descriptions. Description has no attributes, only text. There can only be one project description per project. A second description element will overwrite the first.


Field Summary
 
Fields inherited from class org.apache.tools.ant.types.DataType
checked, description, ref
 
Fields inherited from class org.apache.tools.ant.ProjectComponent
project
 
Constructor Summary
Description()
           
 
Method Summary
 void addText(java.lang.String text)
          Adds descriptive text to the project.
static java.lang.String getDescription(Project project)
          Return the descriptions from all the targets of a project.
 
Methods inherited from class org.apache.tools.ant.types.DataType
checkAttributesAllowed, checkChildrenAllowed, circularReference, dieOnCircularReference, getCheckedRef, getDescription, getRefid, isChecked, isReference, noChildrenAllowed, setChecked, setDescription, setRefid, tooManyAttributes
 
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
 

Constructor Detail

Description

public Description()
Method Detail

addText

public void addText(java.lang.String text)
Adds descriptive text to the project.

Parameters:
text - the descriptive text

getDescription

public static java.lang.String getDescription(Project project)
Return the descriptions from all the targets of a project.

Parameters:
project - the project to get the descriptions for.
Returns:
a string containing the concatenated descriptions of the targets.


Copyright 2000-2005 Apache Software Foundation. All Rights Reserved.