Eclipse PDE
Release 3.2

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.

This interface is not intended to be implemented by clients.


Method Summary
 void print(String string)
          Print the given string to the Ant script.
 void printAntCallTask(String target, boolean inheritAll, Map params)
          Print an ant call task as defined by AntCall}.
 void printAttribute(String name, String value, boolean mandatory)
          Print an XML attribute.
 void printComment(String comment)
          Print the given comment to the Ant script folled by a carriage-return.
 void printEndTag(String endTag)
          Print tagName as an xml end tag (</tagName>).
 void println()
          Print a empty line.
 void println(String string)
          Print the given string followed by a carriage-return.
 void printStartTag(String tagName)
          Print tagName as an xml begin tag (<tagName>).
 void printTabs()
          Print as many tabs as current nesting level requires
 void printTargetDeclaration(String name, String depends, String ifClause, String unlessClause, String description)
          Print a target declaration.
 void printTargetEnd()
          Print the end tag for a target declaration.
 

Method Detail

print

public void print(String string)
Print the given string to the Ant script.

Parameters:
string - the string to print.

printComment

public void printComment(String comment)
Print the given comment to the Ant script folled by a carriage-return.

Parameters:
comment - the comment to print.

println

public void println(String string)
Print the given string followed by a carriage-return.

Parameters:
string - the string to print.

println

public void println()
Print a empty line.


printAntCallTask

public void printAntCallTask(String target,
                             boolean inheritAll,
                             Map params)
Print an ant call task as defined by AntCall}.

Parameters:
target - the target executed by the call. This value can not be null.
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 be null

printAttribute

public void printAttribute(String name,
                           String value,
                           boolean mandatory)
Print an XML attribute. name=value.

Parameters:
name - the name of the attribute to print. This value can not be null.
value - the name of the value to print. This value can be null.
mandatory - indicate whether or not the value is mandatory. If the value is null and the attribute is mandatory, the printed value will be "".

printStartTag

public void printStartTag(String tagName)
Print tagName as an xml begin tag (<tagName>).

Parameters:
tagName - the tag to print.

printEndTag

public void printEndTag(String endTag)
Print tagName as an xml end tag (</tagName>).

Parameters:
endTag - the tag to print.

printTabs

public void printTabs()
Print as many tabs as current nesting level requires


printTargetDeclaration

public 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 be null.
depends - a comma-separated list of names of targets on which this target depends. This value can be null.
ifClause - the name of the property that must be set in order for this target to execute. This value can be null
unlessClause - the name of the property that must not be set in order for this target to execute. This value can be null
description - a short description of this target's function. This value can be null

printTargetEnd

public void printTargetEnd()
Print the end tag for a target declaration.


Eclipse PDE
Release 3.2

Copyright (c) IBM Corp. and others 2000, 2006. All Rights Reserved.