InstallData (IzPack api module 5.2.4 API)

All Known Implementing Classes:

AutomatedInstallData
```
public interface InstallData
```
InstallData holds data used throughout the installation.

Author:

Tim Anderson

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`ESTIMATED_SIZE` The estimated size of the installation on disk.
`static String`	`INSTALL_PATH` The install path.
`static String`	`INSTALLATION_INFORMATION` Installation information file name.
`static String`	`INSTALLER_MODE` Installer mode - auto, console, gui
`static String`	`INSTALLER_MODE_AUTO`
`static String`	`INSTALLER_MODE_CONSOLE`
`static String`	`INSTALLER_MODE_GUI`
`static String`	`MEDIA_PATH` The path for multi-volume installation media.
`static String`	`MODIFY_INSTALLATION` Determines if the installation is being modified.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`List<Pack>`	`getAllPacks()` Returns all packs.
`Object`	`getAttribute(String name)` Returns the value of the named attribute.
`List<Pack>`	`getAvailablePacks()` Returns the packs available to be installed on the current platform.
`String`	`getDefaultInstallPath()` Returns the default install path.
`List<DynamicInstallerRequirementValidator>`	`getDynamicInstallerRequirements()` Returns the dynamic installer requirement validators.
`Info`	`getInfo()` Returns the installation information.
`IXMLElement`	`getInstallationRecord()` Returns the XML data for automated installation.
`List<InstallerRequirement>`	`getInstallerRequirements()` Returns the installer requirements.
`String`	`getInstallPath()` Returns the install path.
`Locale`	`getLocale()` Returns the current locale.
`String`	`getLocaleISO2()` Returns the current locale's ISO2 language code.
`String`	`getLocaleISO3()` Returns the current locale's ISO3 language code.
`String`	`getMediaPath()` Returns the media path for multi-volume installation.
`Messages`	`getMessages()` Returns the localised messages.
`List<Panel>`	`getPanelsOrder()` Returns the panels.
`Platform`	`getPlatform()` Returns the current platform.
`RulesEngine`	`getRules()` Returns the rules.
`List<Pack>`	`getSelectedPacks()` Returns the selected packs.
`String`	`getVariable(String name)` Returns the current value of the specified variable.
`Variables`	`getVariables()` Returns the variables.
`boolean`	`isCanClose()` Determines if the installer can close.
`boolean`	`isInstallSuccess()` Determines if the installation was successful.
`boolean`	`isRebootNecessary()` Determines if a reboot is required after installation.
`void`	`refreshVariables()` Refreshes dynamic variables.
`void`	`setAttribute(String name, Object value)` Sets a named attribute.
`void`	`setDefaultInstallPath(String path)` Sets the default install path.
`void`	`setInstallPath(String path)` Sets the install path.
`void`	`setInstallSuccess(boolean success)` Determines if the installation was successful.
`void`	`setMediaPath(String path)` Sets the media path for multi-volume installation.
`void`	`setRebootNecessary(boolean reboot)` Determines if a reboot is required after installation.
`void`	`setSelectedPacks(List<Pack> selectedPacks)` Sets the selected packs.
`void`	`setVariable(String name, String value)` Sets a variable to the specified value.

- Field Detail
  - MEDIA_PATH
```
static final String MEDIA_PATH
```
    The path for multi-volume installation media.
    
    See Also:
    
    Constant Field Values
  - INSTALL_PATH
```
static final String INSTALL_PATH
```
    The install path.
    
    See Also:
    
    Constant Field Values
  - ESTIMATED_SIZE
```
static final String ESTIMATED_SIZE
```
    The estimated size of the installation on disk.
    
    See Also:
    
    Constant Field Values
  - MODIFY_INSTALLATION
```
static final String MODIFY_INSTALLATION
```
    Determines if the installation is being modified.
    
    See Also:
    
    Constant Field Values
  - INSTALLATION_INFORMATION
```
static final String INSTALLATION_INFORMATION
```
    Installation information file name.
    
    See Also:
    
    Constant Field Values
  - INSTALLER_MODE
```
static final String INSTALLER_MODE
```
    Installer mode - auto, console, gui
    
    See Also:
    
    Constant Field Values
  - INSTALLER_MODE_AUTO
```
static final String INSTALLER_MODE_AUTO
```
    See Also:
    
    Constant Field Values
  - INSTALLER_MODE_CONSOLE
```
static final String INSTALLER_MODE_CONSOLE
```
    See Also:
    
    Constant Field Values
  - INSTALLER_MODE_GUI
```
static final String INSTALLER_MODE_GUI
```
    See Also:
    
    Constant Field Values
- Method Detail
  - setVariable
```
void setVariable(String name,
                 String value)
```
    Sets a variable to the specified value.
    This is short hand for getVariables().set(name, value).
    
    Parameters:
    
    name - the name of the variable
    
    value - the new value of the variable. May be null
    
    See Also:
    
    getVariable(java.lang.String)
  - getVariable
```
String getVariable(String name)
```
    Returns the current value of the specified variable.
    This is short hand for getVariables().get(name).
    
    Parameters:
    
    name - the name of the variable
    
    Returns:
    
    the value of the variable or null if not set
    
    See Also:
    
    setVariable(java.lang.String, java.lang.String)
  - refreshVariables
```
void refreshVariables()
```
    Refreshes dynamic variables.
    This is short hand for getVariables().refresh().
  - getVariables
```
Variables getVariables()
```
    Returns the variables.
    
    Returns:
    
    the variables
  - setInstallPath
```
void setInstallPath(String path)
```
    Sets the install path.
    
    Parameters:
    
    path - the new install path. May be null
    
    See Also:
    
    getInstallPath()
  - getInstallPath
```
String getInstallPath()
```
    Returns the install path.
    
    Returns:
    
    the current install path. May be null
    
    See Also:
    
    setInstallPath(java.lang.String)
  - setDefaultInstallPath
```
void setDefaultInstallPath(String path)
```
    Sets the default install path.
    
    Parameters:
    
    path - the default install path. May be null
    
    See Also:
    
    getDefaultInstallPath()
  - getDefaultInstallPath
```
String getDefaultInstallPath()
```
    Returns the default install path.
    
    Returns:
    
    the default install path. May be null
    
    See Also:
    
    setDefaultInstallPath(java.lang.String)
  - setMediaPath
```
void setMediaPath(String path)
```
    Sets the media path for multi-volume installation.
    
    Parameters:
    
    path - the media path. May be null
  - getMediaPath
```
String getMediaPath()
```
    Returns the media path for multi-volume installation.
    
    Returns:
    
    the media path. May be null
  - getRules
```
RulesEngine getRules()
```
    Returns the rules.
    
    Returns:
    
    the rules
  - getLocale
```
Locale getLocale()
```
    Returns the current locale.
    
    Returns:
    
    the current locale. May be null
  - getLocaleISO3
```
String getLocaleISO3()
```
    Returns the current locale's ISO3 language code.
    
    Returns:
    
    the current locale's ISO3 language code. May be null
  - getLocaleISO2
```
String getLocaleISO2()
```
    Returns the current locale's ISO2 language code.
    
    Returns:
    
    the current locale's ISO2 language code. May be null
  - getMessages
```
Messages getMessages()
```
    Returns the localised messages.
    
    Returns:
    
    the localised messages
  - getInfo
```
Info getInfo()
```
    Returns the installation information.
    
    Returns:
    
    the installation information
  - getPlatform
```
Platform getPlatform()
```
    Returns the current platform.
    
    Returns:
    
    the current platform
  - getAllPacks
```
List<Pack> getAllPacks()
```
    Returns all packs.
    
    Returns:
    
    the packs
  - getAvailablePacks
```
List<Pack> getAvailablePacks()
```
    Returns the packs available to be installed on the current platform.
    
    Returns:
    
    the available packs
  - getSelectedPacks
```
List<Pack> getSelectedPacks()
```
    Returns the selected packs.
    
    Returns:
    
    the selected packs
  - setSelectedPacks
```
void setSelectedPacks(List<Pack> selectedPacks)
```
    Sets the selected packs.
    
    Parameters:
    
    selectedPacks - the selected packs
  - getPanelsOrder
```
List<Panel> getPanelsOrder()
```
    Returns the panels.
    
    Returns:
    
    the panels
  - isCanClose
```
boolean isCanClose()
```
    Determines if the installer can close.
    
    Returns:
    
    true if the installer can close; otherwise false
  - isInstallSuccess
```
boolean isInstallSuccess()
```
    Determines if the installation was successful.
    NOTE: the result of this method is undefined until the panels have completed or failed.
    
    Returns:
    
    true if the installation was successful
  - setInstallSuccess
```
void setInstallSuccess(boolean success)
```
    Determines if the installation was successful.
    
    Parameters:
    
    success - if true indicates installation was successful
  - isRebootNecessary
```
boolean isRebootNecessary()
```
    Determines if a reboot is required after installation.
    
    Returns:
    
    true if a reboot is required
  - setRebootNecessary
```
void setRebootNecessary(boolean reboot)
```
    Determines if a reboot is required after installation.
    
    Parameters:
    
    reboot - if true indicates a reboot is required
  - getInstallationRecord
```
IXMLElement getInstallationRecord()
```
    Returns the XML data for automated installation.
    
    Returns:
    
    the XML data
  - getInstallerRequirements
```
List<InstallerRequirement> getInstallerRequirements()
```
    Returns the installer requirements.
    These are evaluated prior to installation, to ensure all prerequisites are met.
    
    Returns:
    
    the installer requirements
  - getDynamicInstallerRequirements
```
List<DynamicInstallerRequirementValidator> getDynamicInstallerRequirements()
```
    Returns the dynamic installer requirement validators.
    These are evaluated on each panel change.
    
    Returns:
    
    the dynamic installer requirement validators
  - setAttribute
```
void setAttribute(String name,
                  Object value)
```
    Sets a named attribute.
    The panels and other IzPack components can attach custom attributes to InstallData to communicate with each other. For example, a set of co-operating custom panels do not need to implement a common data storage but can use InstallData singleton. The name of the attribute should include the package and class name to prevent name space collisions.
    
    Parameters:
    
    name - the name of the attribute to set
    
    value - the value of the attribute or null to unset the attribute
    
    See Also:
    
    getAttribute(java.lang.String)
  - getAttribute
```
Object getAttribute(String name)
```
    Returns the value of the named attribute.
    
    Parameters:
    
    name - the name of the attribute
    
    Returns:
    
    the value of the attribute or null if not set
    
    See Also:
    
    setAttribute(java.lang.String, java.lang.Object)

Interface InstallData

Field Summary

Method Summary

Field Detail

MEDIA_PATH

INSTALL_PATH

ESTIMATED_SIZE

MODIFY_INSTALLATION

INSTALLATION_INFORMATION

INSTALLER_MODE

INSTALLER_MODE_AUTO

INSTALLER_MODE_CONSOLE

INSTALLER_MODE_GUI

Method Detail

setVariable

getVariable

refreshVariables

getVariables

setInstallPath

getInstallPath

setDefaultInstallPath

getDefaultInstallPath

setMediaPath

getMediaPath

getRules

getLocale

getLocaleISO3

getLocaleISO2

getMessages

getInfo

getPlatform

getAllPacks

getAvailablePacks

getSelectedPacks

setSelectedPacks

getPanelsOrder

isCanClose

isInstallSuccess

setInstallSuccess

isRebootNecessary

setRebootNecessary

getInstallationRecord

getInstallerRequirements

getDynamicInstallerRequirements

setAttribute

getAttribute