Top Description Fields Constructors Methods
org.apache.tools.ant.types

public Class Description

extends DataType
Class Inheritance
Imports
java.util.List, java.util.stream.Collectors, .Stream, org.apache.tools.ant.MagicNames, .Project, .ProjectHelper, .Target, .Task, .UnknownElement, org.apache.tools.ant.helper.ProjectHelper2, .ProjectHelperImpl
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

Inherited from org.apache.tools.ant.types.DataType:
checkedref

Constructor Summary

AccessConstructor and Description
public
Description()

Method Summary

Modifier and TypeMethod and Description
public void
addText(String
the descriptive text
text)

Adds descriptive text to the project.

private static void
concatDescriptions(Project project, Target t, StringBuilder description)

private static List<Task>
findElementInTarget(Target t, String name)

public static String

Returns:

a string containing the concatenated descriptions of the targets.
getDescription(Project
the project to get the descriptions for.
project)

Return the descriptions from all the targets of a project.

Inherited from org.apache.tools.ant.types.DataType:
checkAttributesAllowedcheckChildrenAllowedcircularReferenceclonedieOnCircularReferencedieOnCircularReferencedieOnCircularReferencegetCheckedRefgetCheckedRefgetCheckedRefgetCheckedRefgetCheckedRefgetDataTypeNamegetRefidinvokeCircularReferenceCheckisCheckedisReferencenoChildrenAllowedpushAndInvokeCircularReferenceChecksetCheckedsetRefidtooManyAttributestoString

Constructor Detail

Descriptionback to summary
public Description()

Method Detail

addTextback to summary
public void addText(String text)

Adds descriptive text to the project.

Parameters
text:String

the descriptive text

concatDescriptionsback to summary
private static void concatDescriptions(Project project, Target t, StringBuilder description)
findElementInTargetback to summary
private static List<Task> findElementInTarget(Target t, String name)
getDescriptionback to summary
public static String getDescription(Project project)

Return the descriptions from all the targets of a project.

Parameters
project:Project

the project to get the descriptions for.

Returns:String

a string containing the concatenated descriptions of the targets.