Package org.eclipse.pde.build
Interface IAntScript
public interface IAntScript
Interface providing helper methods to produce Ant scripts.
It contains convenience methods for creating the XML elements required for Ant scripts. See the Ant website for more details on Ant scripts and the particular Ant tasks.
- Restriction:
- This interface is not intended to be implemented by clients.
-
Method Summary
Modifier and TypeMethodDescriptionvoidDecrement the nesting levelvoidIncrement the nesting levelvoidPrint the given string to the Ant script.voidprintAntCallTask(String target, boolean inheritAll, Map<String, String> params) Print an ant call task as defined by AntCall}.voidprintAttribute(String name, String value, boolean mandatory) Print an XML attribute.voidprintComment(String comment) Print the given comment to the Ant script folled by a carriage-return.voidprintEchoTask(String file, String message, String level) Print an echo taskvoidprintElement(String tag, Map<String, String> attributes) Print an xml element with attributes (<tagName [attributesvoidPrint the end of the macrovoidprintEndTag(String endTag) Print tagName as an xml end tag (</tagName>).voidprintln()Print a empty line.voidPrint the given string followed by a carriage-return.voidprintMacroDef(String macroName, List<String> attributes) Print the beginning of a macro definition.voidprintStartTag(String tagName) Print tagName as an xml begin tag (<tagName>).voidprintStartTag(String tag, Map<String, String> attributes) Print tagName as an xml begin tag with attributes (<tagName [attributes...]voidPrint as many tabs as current nesting level requiresvoidprintTargetDeclaration(String name, String depends, String ifClause, String unlessClause, String description) Print a target declaration.voidPrint the end tag for a target declaration.
-
Method Details
-
print
Print the given string to the Ant script.- Parameters:
string- the string to print.
-
printComment
Print the given comment to the Ant script folled by a carriage-return.- Parameters:
comment- the comment to print.
-
println
Print the given string followed by a carriage-return.- Parameters:
string- the string to print.
-
println
void println()Print a empty line. -
printAntCallTask
Print an ant call task as defined by AntCall}.- Parameters:
target- the target executed by the call. This value can not benull.inheritAll- If true, pass all properties to the new Ant project.params- Specifies as key / value pairs, the properties to set before running the specified target. This value can benull
-
printAttribute
Print an XML attribute.name=value.- Parameters:
name- the name of the attribute to print. This value can not benull.value- the name of the value to print. This value can benull.mandatory- indicate whether or not the value is mandatory. If thevalueisnulland the attribute is mandatory, the printed value will be "".
-
printStartTag
Print tagName as an xml begin tag (<tagName>).- Parameters:
tagName- the tag to print.
-
printStartTag
Print tagName as an xml begin tag with attributes (<tagName [attributes...] >).- Parameters:
tag- the tag to print.attributes- attributes for the tag.- Since:
- 3.6
-
printEndTag
Print tagName as an xml end tag (</tagName>).- Parameters:
endTag- the tag to print.
-
printElement
Print an xml element with attributes (<tagName [attributes...] />).- Parameters:
tag- the tag to printattributes- the attributes for the tag- Since:
- 3.6
-
printTabs
void printTabs()Print as many tabs as current nesting level requires -
incrementIdent
void incrementIdent()Increment the nesting level- Since:
- 3.6
-
decrementIdent
void decrementIdent()Decrement the nesting level- Since:
- 3.6
-
printTargetDeclaration
void printTargetDeclaration(String name, String depends, String ifClause, String unlessClause, String description) Print a target declaration. See Ant's targets.- Parameters:
name- the name of the target. This value can not benull.depends- a comma-separated list of names of targets on which this target depends. This value can benull.ifClause- the name of the property that must be set in order for this target to execute. This value can benullunlessClause- the name of the property that must not be set in order for this target to execute. This value can benulldescription- a short description of this target's function. This value can benull
-
printTargetEnd
void printTargetEnd()Print the end tag for a target declaration. -
printEchoTask
Print an echo task- Parameters:
file- - file to write the message to (or null)message- - the message to echolevel- - the level to report the message (ie, "error", "warning", "info"), "warning" is the default if null is passed.- Since:
- 3.6
-
printMacroDef
Print the beginning of a macro definition.- Parameters:
macroName- the name of the macroattributes- the attributes of the macro- Since:
- 3.6
-
printEndMacroDef
void printEndMacroDef()Print the end of the macro- Since:
- 3.6
-