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
Env() Create instance of Env class describing environment for Ant target execution.

Method Summary

Modifier and Type	Method and Description
Set<String>	getConcealedProperties() Returns names of the properties whose values should not be visible to the user.
OutputStream	getLogger() Get output stream.
Properties	getProperties() Get current Ant script execution properties.
int	getVerbosity() Get verbosity of Ant script execution.
void	setConcealedProperties(Set<? extends String> properties) Sets names of the properties whose values should not be visible to the user.
void	setLogger(OutputStream outputStream) Deprecated. Usage of a custom output stream is not recommended, and prevents some Ant module features from working correctly.
void	setPreferredName(String name) Sets the preferred name for output windows.
void	setProperties(Properties p) Set properties of Ant script execution.
void	setSaveAllDocuments(boolean shouldSave) Overrides the default save all behavior.
void	setTabReplaceStrategy(java.util.function.Predicate<String> canReplace, java.util.function.Predicate<String> canBeReplaced) Sets the output tab replacement strategy.
void	setUserAction(boolean userAction) Marks the execution as an user action.
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

Env

public 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

setConcealedProperties

public void setConcealedProperties(@NonNull
                                   Set<? extends String> properties)

Sets names of the properties whose values should not be visible to the user. This method can be used to safely pass password to ant script.

Parameters:

properties - the names of properties to be concealed

Since:

3.71

getConcealedProperties

@NonNull
public Set<String> getConcealedProperties()

Returns names of the properties whose values should not be visible to the user.

Returns:

the Set of property names

Since:

3.71

setSaveAllDocuments

public void setSaveAllDocuments(boolean shouldSave)

Overrides the default save all behavior.

Parameters:

shouldSave - if true all modified documents are saved before running Ant.

Since:

3.84

setPreferredName

public void setPreferredName(@NullAllowed
                             String name)

Sets the preferred name for output windows.

Parameters:

name - the preferred name in case of null the name is assigned automatically

Since:

3.84

setTabReplaceStrategy

public void setTabReplaceStrategy(@NonNull
                                  java.util.function.Predicate<String> canReplace,
                                  @NonNull
                                  java.util.function.Predicate<String> canBeReplaced)

Sets the output tab replacement strategy. When the IDE is set to the automatic close tabs mode the tabs created by the previous run of the AntTargetExecutor are closed by successive run. This behavior can be overridden by this method.

Parameters:

canReplace - the Predicate used to decide if this execution can replace existing tab. The predicate parameter is a name of tab being replaced.

canBeReplaced - the Predicate used to decide if tab can be replaced by a new execution. The predicate parameter is a name of a tab being created.

Since:

3.84

setUserAction

public void setUserAction(boolean userAction)

Marks the execution as an user action. The executions marked as user actions are registered in the UI support BuildExecutionSupport. By default the execution is an user action.

Parameters:

userAction - if true the execution is registered into the BuildExecutionSupport

Since:

3.85