com.izforge.izpack.api.data

Class Info

java.lang.Object

com.izforge.izpack.api.data.Info

All Implemented Interfaces:

Serializable

public class Info
extends Object
implements Serializable

Contains some information for an installer, as defined in the section of the XML files.

Author:

Julien Ponge

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Info.Author This class represents an author.
static class	Info.TempDir Represents a temporary directory with a randomly generated file name starting with the specified prefix and ending with the specified suffix.

Field Summary

Fields

Modifier and Type	Field and Description
static String	EXPIRE_DATE_FORMAT The format of the expiration date
static int	REBOOT_ACTION_ALWAYS Force rebooting regardless whether there are pending operations
static int	REBOOT_ACTION_ASK Ask before reboot automatically, on pending file operations only
static int	REBOOT_ACTION_IGNORE Force ignoring pending file operations
static int	REBOOT_ACTION_NOTICE Notice the user interactively but don't actually reboot, on pending file operations only

Constructor Summary

Constructors

Constructor and Description
Info() The constructor, deliberately void.

Method Summary

Modifier and Type	Method and Description
void	addAuthor(Info.Author author) Adds an author to the authors list.
void	addTempDir(Info.TempDir tempDir)
String	getAppName() Gets the application name.
String	getAppURL() Gets the application URL.
String	getAppVersion() Gets the version.
ArrayList<Info.Author>	getAuthors() Gets the authors list.
PackCompression	getCompressionFormat()
Date	getExpiresDate()
boolean	getHideForceOption()
String	getInstallationSubPath() Gets the installation subpath.
String	getInstallerBase() Gets the installer name.
String	getJavaVersion() Gets the Java version required.
boolean	getJavaVersionStrict() Gets the Java version strict parameter.
String	getPrivilegedExecutionConditionID()
int	getRebootAction()
String	getRebootActionConditionID()
String	getSummaryLogFilePath() Returns the summary log file path.
Set<Info.TempDir>	getTempDirs()
String	getUninstallerCondition()
String	getUninstallerName() Returns the name of the uninstaller.
String	getUninstallerPath() Returns the path to the uninstaller
String	getUnpackerClassName()
String	getWebDirURL() Gets the webDir URL if it has been specified
boolean	isJdkRequired()
boolean	isPrivilegedExecutionRequired()
boolean	isPrivilegedExecutionRequiredUninstaller()
boolean	isReadInstallationInformation()
boolean	isSingleInstance()
boolean	isWriteInstallationInformation()
void	setAppName(String appName) Sets the application name.
void	setAppURL(String appURL) Sets the application URL.
void	setAppVersion(String appVersion) Sets the version.
void	setCompressionFormat(PackCompression compression)
void	setExpiresDate(Date value)
void	setExpiresDate(String value)
void	setHideForceOption(boolean hideForceOption)
void	setInstallationSubPath(String installationSubPath) Sets the installation subpath.
void	setInstallerBase(String installerBase) Sets the installer name.
void	setJavaVersion(String javaVersion) Sets the minimum Java version required.
void	setJavaVersionStrict(boolean javaVersionStrict) Sets the minimum Java version strict parameter.
void	setJdkRequired(boolean jdkRequired)
void	setPrivilegedExecutionConditionID(String privilegedExecutionConditionID)
void	setReadInstallationInformation(boolean readInstallationInformation)
void	setRebootAction(int rebootAction)
void	setRebootActionConditionID(String rebootActionConditionID)
void	setRequirePrivilegedExecution(boolean requirePrivilegedExecution)
void	setRequirePrivilegedExecutionUninstaller(boolean required)
void	setSingleInstance(boolean flag)
void	setSummaryLogFilePath(String summaryLogFilePath) Sets the summary log file path.
void	setUninstallerCondition(String uninstallerCondition)
void	setUninstallerName(String name) Sets the name of the uninstaller.
void	setUninstallerPath(String path) Sets the path to the uninstaller
void	setUnpackerClassName(String unpackerClassName)
void	setWebDirURL(String url) Sets the webDir URL.
void	setWriteInstallationInformation(boolean writeInstallationInformation)

Methods inherited from class java.lang.Object

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

Field Detail

REBOOT_ACTION_IGNORE

public static final int REBOOT_ACTION_IGNORE

Force ignoring pending file operations

See Also:

Constant Field Values

REBOOT_ACTION_NOTICE

public static final int REBOOT_ACTION_NOTICE

Notice the user interactively but don't actually reboot, on pending file operations only

See Also:

Constant Field Values

REBOOT_ACTION_ASK

public static final int REBOOT_ACTION_ASK

Ask before reboot automatically, on pending file operations only

See Also:

Constant Field Values

REBOOT_ACTION_ALWAYS

public static final int REBOOT_ACTION_ALWAYS

Force rebooting regardless whether there are pending operations

See Also:

Constant Field Values

EXPIRE_DATE_FORMAT

public static final String EXPIRE_DATE_FORMAT

The format of the expiration date

See Also:

Constant Field Values

Constructor Detail

Info

public Info()

The constructor, deliberately void.

Method Detail

isPrivilegedExecutionRequired

public boolean isPrivilegedExecutionRequired()

setRequirePrivilegedExecution

public void setRequirePrivilegedExecution(boolean requirePrivilegedExecution)

isPrivilegedExecutionRequiredUninstaller

public boolean isPrivilegedExecutionRequiredUninstaller()

setRequirePrivilegedExecutionUninstaller

public void setRequirePrivilegedExecutionUninstaller(boolean required)

getPrivilegedExecutionConditionID

public String getPrivilegedExecutionConditionID()

setPrivilegedExecutionConditionID

public void setPrivilegedExecutionConditionID(String privilegedExecutionConditionID)

getRebootAction

public int getRebootAction()

setRebootAction

public void setRebootAction(int rebootAction)

getRebootActionConditionID

public String getRebootActionConditionID()

setRebootActionConditionID

public void setRebootActionConditionID(String rebootActionConditionID)

setAppName

public void setAppName(String appName)

Sets the application name.

Parameters:

appName - The new application name.

getAppName

public String getAppName()

Gets the application name.

Returns:

The application name.

setAppVersion

public void setAppVersion(String appVersion)

Sets the version.

Parameters:

appVersion - The application version.

getAppVersion

public String getAppVersion()

Gets the version.

Returns:

The application version.

addAuthor

public void addAuthor(Info.Author author)

Adds an author to the authors list.

Parameters:

author - The author to add.

getAuthors

public ArrayList<Info.Author> getAuthors()

Gets the authors list.

Returns:

The authors list.

setAppURL

public void setAppURL(String appURL)

Sets the application URL.

Parameters:

appURL - The application URL.

getAppURL

public String getAppURL()

Gets the application URL.

Returns:

The application URL.

setJavaVersion

public void setJavaVersion(String javaVersion)

Sets the minimum Java version required.

Parameters:

javaVersion - The Java version.

getJavaVersion

public String getJavaVersion()

Gets the Java version required.

Returns:

The Java version.

setJavaVersionStrict

public void setJavaVersionStrict(boolean javaVersionStrict)

Sets the minimum Java version strict parameter.

Parameters:

javaVersionStrict - The Java version strict parameter.

getJavaVersionStrict

public boolean getJavaVersionStrict()

Gets the Java version strict parameter.

Returns:

The Java version strict parameter.

setInstallerBase

public void setInstallerBase(String installerBase)

Sets the installer name.

Parameters:

installerBase - The new installer name.

getInstallerBase

public String getInstallerBase()

Gets the installer name.

Returns:

The name of the installer file, without the jar suffix.

setWebDirURL

public void setWebDirURL(String url)

Sets the webDir URL.

Parameters:

url - The application URL.

getWebDirURL

public String getWebDirURL()

Gets the webDir URL if it has been specified

Returns:

The webDir URL from which the installer is retrieved, or null if non has been set.

setUninstallerName

public void setUninstallerName(String name)

Sets the name of the uninstaller.

Parameters:

name - the name of the uninstaller.

getUninstallerName

public String getUninstallerName()

Returns the name of the uninstaller.

Returns:

the name of the uninstaller.

setUninstallerPath

public void setUninstallerPath(String path)

Sets the path to the uninstaller

Parameters:

path - the path to the uninstaller

getUninstallerPath

public String getUninstallerPath()

Returns the path to the uninstaller

Returns:

the path to the uninstaller

isJdkRequired

public boolean isJdkRequired()

setJdkRequired

public void setJdkRequired(boolean jdkRequired)

getCompressionFormat

public PackCompression getCompressionFormat()

setCompressionFormat

public void setCompressionFormat(PackCompression compression)

getInstallationSubPath

public String getInstallationSubPath()

Gets the installation subpath.

Returns:

the installation subpath

setInstallationSubPath

public void setInstallationSubPath(String installationSubPath)

Sets the installation subpath.

Parameters:

installationSubPath - subpath to be set

getSummaryLogFilePath

public String getSummaryLogFilePath()

Returns the summary log file path.

Returns:

the summary log file path

setSummaryLogFilePath

public void setSummaryLogFilePath(String summaryLogFilePath)

Sets the summary log file path.

Parameters:

summaryLogFilePath - the summary log file path to set

getUnpackerClassName

public String getUnpackerClassName()

setUnpackerClassName

public void setUnpackerClassName(String unpackerClassName)

isWriteInstallationInformation

public boolean isWriteInstallationInformation()

setWriteInstallationInformation

public void setWriteInstallationInformation(boolean writeInstallationInformation)

isReadInstallationInformation

public boolean isReadInstallationInformation()

setReadInstallationInformation

public void setReadInstallationInformation(boolean readInstallationInformation)

isSingleInstance

public boolean isSingleInstance()

setSingleInstance

public void setSingleInstance(boolean flag)

getHideForceOption

public boolean getHideForceOption()

setHideForceOption

public void setHideForceOption(boolean hideForceOption)

getUninstallerCondition

public String getUninstallerCondition()

setUninstallerCondition

public void setUninstallerCondition(String uninstallerCondition)

addTempDir

public void addTempDir(Info.TempDir tempDir)

getTempDirs

public Set<Info.TempDir> getTempDirs()

getExpiresDate

public Date getExpiresDate()

setExpiresDate

public void setExpiresDate(Date value)

setExpiresDate

public void setExpiresDate(String value)
                    throws ParseException

Throws:

ParseException