org.apache.tools.ant.module.api

Class AntTargetExecutor.Env

java.lang.Object

org.apache.tools.ant.module.api.AntTargetExecutor.Env

Enclosing class:

AntTargetExecutor

public static final class AntTargetExecutor.Env
extends Object

Class describing the environment in which the Ant target will be executed. The class can be used for customization of properties avaialble during the execution, verbosity of Ant target execution and output stream definition.

Constructor Summary

Constructors

Constructor and Description
AntTargetExecutor.Env() Create instance of Env class describing environment for Ant target execution.

Method Summary

Methods

Modifier and Type	Method and Description
OutputStream	getLogger() Get output stream.
Properties	getProperties() Get current Ant script execution properties.
int	getVerbosity() Get verbosity of Ant script execution.
void	setLogger(OutputStream outputStream) Deprecated. Usage of a custom output stream is not recommended, and prevents some Ant module features from working correctly.
void	setProperties(Properties p) Set properties of Ant script execution.
void	setVerbosity(int v) Set verbosity of Ant script execution.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AntTargetExecutor.Env

public AntTargetExecutor.Env()

Create instance of Env class describing environment for Ant target execution.

Method Detail

setVerbosity

public void setVerbosity(int v)

Set verbosity of Ant script execution.

Parameters:

v - the new verbosity (e.g. AntEvent.LOG_VERBOSE)

getVerbosity

public int getVerbosity()

Get verbosity of Ant script execution.

Returns:

the current verbosity (e.g. AntEvent.LOG_VERBOSE)

setProperties

public void setProperties(Properties p)

Set properties of Ant script execution.

Parameters:

p - a set of name/value pairs passed to Ant (will be cloned)

getProperties

public Properties getProperties()

Get current Ant script execution properties. The clone of real properties is returned.

Returns:

the current name/value pairs passed to Ant

setLogger

@Deprecated
public void setLogger(OutputStream outputStream)

Deprecated. Usage of a custom output stream is not recommended, and prevents some Ant module features from working correctly.

Set output stream into which the output of the Ant script execution will be sent. If not set the standard NetBeans output window will be used.

Parameters:

outputStream - a stream to send output to, or null to reset

See Also:

AntOutputStream

getLogger

public OutputStream getLogger()

Get output stream. If no output stream was set then null will be returned what means that standard NetBeans output window will be used.

Returns:

the output stream to which Ant output will be sent, or null