AntAction (IzPack event module 5.2.4 API)

java.lang.Object
- com.izforge.izpack.event.ActionBase
- - com.izforge.izpack.event.AntAction

All Implemented Interfaces:

Serializable
```
public class AntAction
extends ActionBase
```
This class contains data and 'perform' logic for ant action listeners.

Author:

Thomas Guenter, Klaus Bartz

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type Field and Description

static String ANTCALL

static String CONDITIONID_ATTR
- Fields inherited from class com.izforge.izpack.event.ActionBase
  AFTERDELETION, AFTERPACK, AFTERPACKS, BEFOREDELETION, BEFOREPACK, BEFOREPACKS, messageID, order, ORDER, UNINSTALL_ORDER, uninstallOrder

Fields
Modifier and Type	Field and Description
`static String`	`ANTCALL`
`static String`	`CONDITIONID_ATTR`

Constructor Summary

Constructors
Constructor and Description

AntAction()
Default constructor

Constructors
Constructor and Description
`AntAction()` Default constructor

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addPropertyFile(String propertyFile)` Adds one property file path to the internal list of property file paths.
`void`	`addTarget(String target)` Adds the given target to the target list which should be performed at installation time.
`void`	`addUninstallTarget(String target)` Adds the given target to the target list which should be performed at uninstallation time.
`File`	`getBuildDir()` Returns the build working directory.
`File`	`getBuildFile()` Returns the build file.
`String`	`getConditionId()`
`File`	`getLogFile()` Returns the current logfile path as string.
`AntLogLevel`	`getLogLevel()` Get Ant log priority level the action uses when logging.
`Properties`	`getProperties()` Returns the properties.
`String`	`getProperty(String name)` Returns the value for the property identified by the given name.
`List<String>`	`getPropertyFiles()` Returns the property file paths as list of strings.
`Prompt.Type`	`getSeverity()` Get severity of this action in case of errors
`List<String>`	`getTargets()` Returns the targets.
`List<String>`	`getUninstallTargets()` Returns the uninstaller targets.
`boolean`	`isQuiet()` Returns the quiet state.
`boolean`	`isVerbose()` Returns the verbose state.
`void`	`performAction(boolean uninstall)` Performs all defined actions.
`void`	`performInstallAction()` Performs all defined install actions.
`void`	`performUninstallAction()` Performs all defined uninstall actions.
`void`	`setBuildDir(File buildDir)` Sets the build working directory to be used to the given string.
`void`	`setBuildFile(File buildFile)` Sets the build file to be used to the given string.
`void`	`setConditionId(String conditionId)`
`void`	`setLogFile(File logFile, boolean append)` Sets the logfile path to the given string.
`void`	`setLogLevel(AntLogLevel logLevel)` Set Ant log priority level the action should use when logging.
`void`	`setProperties(Properties properties)` Sets the internal properties to the given properties.
`void`	`setProperty(String name, String value)` Sets the given value to the property identified by the given name.
`void`	`setPropertyFiles(List<String> propertyFiles)` Sets the property file path list to the given list.
`void`	`setQuiet(boolean quiet)` Sets whether the associated ant task should be performed quiet or not.
`void`	`setSeverity(Prompt.Type severity)` Set severity of this action in case of errors
`void`	`setTargets(ArrayList<String> targets)` Sets the targets which should be performed at installation time.
`void`	`setUninstallTargets(ArrayList<String> targets)` Sets the targets which should be performed at uninstallation time.
`void`	`setVerbose(boolean verbose)` Sets the verbose state.
`void`	`throwBuildException(IzPackException e)` Wraps a Ant `BuildException` to an `InstallerException`.

Methods inherited from class com.izforge.izpack.event.ActionBase
getMessageID, getOrder, getUninstallOrder, setMessageID, setOrder, setUninstallOrder

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - CONDITIONID_ATTR
```
public static final String CONDITIONID_ATTR
```
    See Also:
    
    Constant Field Values
  - ANTCALL
```
public static final String ANTCALL
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - AntAction
```
public AntAction()
```
    Default constructor
- Method Detail
  - performInstallAction
```
public void performInstallAction()
                          throws IzPackException
```
    Performs all defined install actions.
    Calls {#performAction performAction(false)}.
    
    Throws:
    
    Exception
    
    IzPackException
  - performUninstallAction
```
public void performUninstallAction()
                            throws IzPackException
```
    Performs all defined uninstall actions.
    Calls {#performAction performAction(true)}.
    
    Throws:
    
    IzPackException - for any error
  - performAction
```
public void performAction(boolean uninstall)
                   throws IzPackException
```
    Performs all defined actions.
    
    Parameters:
    
    uninstall - An install/uninstall switch. If this is true only the uninstall actions, otherwise only the install actions are being performed.
    
    Throws:
    
    IzPackException - for any error
    
    See Also:
    
    for calling all install actions., for calling all uninstall actions.
  - getConditionId
```
public String getConditionId()
```
  - setConditionId
```
public void setConditionId(String conditionId)
```
  - getBuildFile
```
public File getBuildFile()
```
    Returns the build file.
    
    Returns:
    
    the build file
  - setBuildFile
```
public void setBuildFile(File buildFile)
```
    Sets the build file to be used to the given string.
    
    Parameters:
    
    buildFile - build file path to be used
  - getBuildDir
```
public File getBuildDir()
```
    Returns the build working directory.
    
    Returns:
    
    the working directory
  - setBuildDir
```
public void setBuildDir(File buildDir)
```
    Sets the build working directory to be used to the given string.
    
    Parameters:
    
    buildDir - build working directory path to be used
  - getLogFile
```
public File getLogFile()
```
    Returns the current logfile path as string.
    
    Returns:
    
    current logfile path
  - setLogFile
```
public void setLogFile(File logFile,
                       boolean append)
```
    Sets the logfile path to the given string.
    
    Parameters:
    
    logFile - to be set
  - getPropertyFiles
```
public List<String> getPropertyFiles()
```
    Returns the property file paths as list of strings.
    
    Returns:
    
    the property file paths
  - addPropertyFile
```
public void addPropertyFile(String propertyFile)
```
    Adds one property file path to the internal list of property file paths.
    
    Parameters:
    
    propertyFile - to be added
  - setPropertyFiles
```
public void setPropertyFiles(List<String> propertyFiles)
```
    Sets the property file path list to the given list. Old settings will be lost.
    
    Parameters:
    
    propertyFiles - list of property file paths to be set
  - getProperties
```
public Properties getProperties()
```
    Returns the properties.
    
    Returns:
    
    the properties
  - setProperties
```
public void setProperties(Properties properties)
```
    Sets the internal properties to the given properties. Old settings will be lost.
    
    Parameters:
    
    properties - properties to be set
  - setProperty
```
public void setProperty(String name,
                        String value)
```
    Sets the given value to the property identified by the given name.
    
    Parameters:
    
    name - key of the property
    
    value - value to be used for the property
  - getProperty
```
public String getProperty(String name)
```
    Returns the value for the property identified by the given name.
    
    Parameters:
    
    name - name of the property
    
    Returns:
    
    value of the property
  - isQuiet
```
public boolean isQuiet()
```
    Returns the quiet state.
    
    Returns:
    
    quiet state
  - setQuiet
```
public void setQuiet(boolean quiet)
```
    Sets whether the associated ant task should be performed quiet or not.
    
    Parameters:
    
    quiet - quiet state to set
  - getLogLevel
```
public AntLogLevel getLogLevel()
```
    Get Ant log priority level the action uses when logging.
    
    Returns:
    
    logLevel
    
    See Also:
    
    Project
  - setLogLevel
```
public void setLogLevel(AntLogLevel logLevel)
```
    Set Ant log priority level the action should use when logging.
    
    Parameters:
    
    logLevel -
    
    See Also:
    
    Project
  - getSeverity
```
public Prompt.Type getSeverity()
```
    Get severity of this action in case of errors
    
    Returns:
  - setSeverity
```
public void setSeverity(Prompt.Type severity)
```
    Set severity of this action in case of errors
    
    Parameters:
    
    severity -
  - getTargets
```
public List<String> getTargets()
```
    Returns the targets.
    
    Returns:
    
    the targets
  - setTargets
```
public void setTargets(ArrayList<String> targets)
```
    Sets the targets which should be performed at installation time. Old settings are lost.
    
    Parameters:
    
    targets - list of targets
  - addTarget
```
public void addTarget(String target)
```
    Adds the given target to the target list which should be performed at installation time.
    
    Parameters:
    
    target - target to be add
  - getUninstallTargets
```
public List<String> getUninstallTargets()
```
    Returns the uninstaller targets.
    
    Returns:
    
    the uninstaller targets
  - setUninstallTargets
```
public void setUninstallTargets(ArrayList<String> targets)
```
    Sets the targets which should be performed at uninstallation time. Old settings are lost.
    
    Parameters:
    
    targets - list of targets
  - addUninstallTarget
```
public void addUninstallTarget(String target)
```
    Adds the given target to the target list which should be performed at uninstallation time.
    
    Parameters:
    
    target - target to be add
  - isVerbose
```
public boolean isVerbose()
```
    Returns the verbose state.
    
    Returns:
    
    verbose state
  - setVerbose
```
public void setVerbose(boolean verbose)
```
    Sets the verbose state.
    
    Parameters:
    
    verbose - state to be set
  - throwBuildException
```
public void throwBuildException(IzPackException e)
                         throws InstallerException
```
    Wraps a Ant BuildException to an InstallerException. This is mainly done for the purpose of cutting of the location from the build failure message. Locations should appear just in logs, not to the user.
    
    Parameters:
    
    e - the IzPackException with the nested BuildException
    
    Throws:
    
    InstallerException

Class AntAction

Field Summary

Fields inherited from class com.izforge.izpack.event.ActionBase

Constructor Summary

Method Summary

Methods inherited from class com.izforge.izpack.event.ActionBase

Methods inherited from class java.lang.Object

Field Detail

CONDITIONID_ATTR

ANTCALL

Constructor Detail

AntAction

Method Detail

performInstallAction

performUninstallAction

performAction

getConditionId

setConditionId

getBuildFile

setBuildFile

getBuildDir

setBuildDir

getLogFile

setLogFile

getPropertyFiles

addPropertyFile

setPropertyFiles

getProperties

setProperties

setProperty

getProperty

isQuiet

setQuiet

getLogLevel

setLogLevel

getSeverity

setSeverity

getTargets

setTargets

addTarget

getUninstallTargets

setUninstallTargets

addUninstallTarget

isVerbose

setVerbose

throwBuildException