Class Description

  extended by
      extended by
          extended by
All Implemented Interfaces:

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
checked, ref
Fields inherited from class
description, location, project
Constructor Summary
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
checkAttributesAllowed, checkChildrenAllowed, circularReference, clone, dieOnCircularReference, dieOnCircularReference, dieOnCircularReference, getCheckedRef, getCheckedRef, getCheckedRef, getCheckedRef, getDataTypeName, getRefid, invokeCircularReferenceCheck, isChecked, isReference, noChildrenAllowed, pushAndInvokeCircularReferenceCheck, setChecked, setRefid, tooManyAttributes, toString
Methods inherited from class
getDescription, getLocation, getProject, log, log, setDescription, setLocation, setProject
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail


public Description()
Method Detail


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

text - the descriptive text


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

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