com.izforge.izpack.api.data

Class PackInfo

java.lang.Object

com.izforge.izpack.api.data.PackInfo

All Implemented Interfaces:

Serializable

public class PackInfo
extends Object
implements Serializable

Temporary holding place for Pack information as the Packager is built. The packager is used by the compiler to collect info about an installer, and finally create the actual installer files.

Author:

Chadwick McHenry

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
PackColor	colour The color of the node.

Constructor Summary

Constructors

Constructor and Description
PackInfo(String name, String id, String description, boolean required, boolean loose, String excludegroup, boolean uninstall, long size) Constructor with required info.

Method Summary

Modifier and Type	Method and Description
void	addDependency(String dependency) The packs that this file depends on
void	addExecutable(ExecutableFile executable) Executables files have their executable flag set, may be executed, and optionally, deleted when finished executing.
void	addFile(File baseDir, File file, String targetfile, List<OsModel> osList, OverrideType override, String overrideRenameTo, Blockable blockable, Map additionals, String condition, Map<String,String> pack200Properties) Add a file or directory to be installed.
void	addInstallGroup(String group) Add an install group to the pack.
void	addOnDeselect(String name, String condition) Determines what packs to be selected or deselected when this pack is deselected.
void	addOnSelect(String name, String condition) Determines what packs to be selected or deselected when this pack is selected.
void	addParsable(ParsableFile parsable) Parsable files have variables substituted after installation.
void	addUpdateCheck(UpdateCheck updateCheck) Executables files have their executable flag set, may be executed, and optionally, deleted when finished executing.
void	addValidator(String validatorClassName)
List<String>	getDependencies()
List<ExecutableFile>	getExecutables() List of parsables for this Pack.
File	getFile(PackFile packFile) The file described by the specified PackFile.
Pack	getPack()
Set<PackFile>	getPackFiles() Set of PackFile objects for this Pack.
Map<PackFile,File>	getPackFilesMap() Provides the complete ordered map of PackFile -> File objects for being able to override entries.
List<ParsableFile>	getParsables() List of parsables for this Pack.
List<UpdateCheck>	getUpdateChecks() List of update checks for this Pack.
void	setCondition(String condition)
void	setGroup(String group) Set the pack group.
void	setHidden(boolean hidden)
void	setOsConstraints(List<OsModel> osConstraints)
void	setPackImgId(String packImgId)
void	setParent(String p)
void	setPreselected(boolean preselected)
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

colour

public transient PackColor colour

The color of the node. This is used for the dependency graph algorithms

Constructor Detail

PackInfo

public PackInfo(String name,
                String id,
                String description,
                boolean required,
                boolean loose,
                String excludegroup,
                boolean uninstall,
                long size)

Constructor with required info.

Parameters:

name - name of the pack

id - id of the pack e.g. to resolve I18N

description - description in English

required - pack is required or not

loose - files of pack should be stored separately or not

excludegroup - name of the exclude group

uninstall - pack must be uninstalled

size - the size of the pack, in bytes

Method Detail

setOsConstraints

public void setOsConstraints(List<OsModel> osConstraints)

setPreselected

public void setPreselected(boolean preselected)

setGroup

public void setGroup(String group)

Set the pack group.

Parameters:

group - the group to associate the pack with.

addInstallGroup

public void addInstallGroup(String group)

Add an install group to the pack.

Parameters:

group - the install group to associate the pack with.

getPack

public Pack getPack()

setHidden

public void setHidden(boolean hidden)

addFile

public void addFile(File baseDir,
                    File file,
                    String targetfile,
                    List<OsModel> osList,
                    OverrideType override,
                    String overrideRenameTo,
                    Blockable blockable,
                    Map additionals,
                    String condition,
                    Map<String,String> pack200Properties)
             throws IOException

Add a file or directory to be installed.

Parameters:

file - the file or basedir to be installed.

targetfile - path file will be installed to.

osList - the target operation system(s) of this pack.

override - what to do if the file already exists when installing

condition - the condition to decide whether the file should be extracted

Throws:

FileNotFoundException - if the file specified does not exist.

IOException

getPackFiles

public Set<PackFile> getPackFiles()

Set of PackFile objects for this Pack.

getPackFilesMap

public Map<PackFile,File> getPackFilesMap()

Provides the complete ordered map of PackFile -> File objects for being able to override entries.

Returns:

the PackFile map

getFile

public File getFile(PackFile packFile)

The file described by the specified PackFile. Returns null if the PackFile did not come from the set returned by getPackFiles().

addParsable

public void addParsable(ParsableFile parsable)

Parsable files have variables substituted after installation.

getParsables

public List<ParsableFile> getParsables()

List of parsables for this Pack.

addExecutable

public void addExecutable(ExecutableFile executable)

Executables files have their executable flag set, may be executed, and optionally, deleted when finished executing.

getExecutables

public List<ExecutableFile> getExecutables()

List of parsables for this Pack.

addUpdateCheck

public void addUpdateCheck(UpdateCheck updateCheck)

Executables files have their executable flag set, may be executed, and optionally, deleted when finished executing.

getUpdateChecks

public List<UpdateCheck> getUpdateChecks()

List of update checks for this Pack.

addDependency

public void addDependency(String dependency)

The packs that this file depends on

getDependencies

public List<String> getDependencies()

setParent

public void setParent(String p)

toString

public String toString()

Overrides:

toString in class Object

setPackImgId

public void setPackImgId(String packImgId)

setCondition

public void setCondition(String condition)

Parameters:

condition - the condition to set

addValidator

public void addValidator(String validatorClassName)

addOnSelect

public void addOnSelect(String name,
                        String condition)

Determines what packs to be selected or deselected when this pack is selected. Packs to be deselected should have their named pre-appended with a "!". Packs to be selected should be specified by name. Additionally a pack will only be selected or deselected if the condition is true. The condition is based on weather some pack is selected or deselected.

Parameters:

name - name of a pack to be selected/deselected

condition - select/deselect a pack when this pack is selected and condition is satisfied or null

addOnDeselect

public void addOnDeselect(String name,
                          String condition)

Determines what packs to be selected or deselected when this pack is deselected. Packs to be deselected should have their named pre-appended with a "!". Packs to be selected should be specified by name. Additionally a pack will only be selected or deselected if the condition is true. The condition is based on weather some pack is selected or deselected.

Parameters:

name - name of a pack to be selected/deselected

condition - select/deselect a pack when this pack is deselected and condition is satisfied or null