com.izforge.izpack.api.data

Class Pack

java.lang.Object

com.izforge.izpack.api.data.Pack

All Implemented Interfaces:

Serializable

public class Pack
extends Object
implements Serializable

Represents a Pack.

Author:

Julien Ponge

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Pack(String name, String langPackId, String description, List<OsModel> osConstraints, List<String> dependencies, boolean required, boolean preselected, boolean loose, String excludeGroup, boolean uninstall, long size) The constructor.

Method Summary

Modifier and Type	Method and Description
void	addChild(String child) Add a child to this pack.
void	addDependant(String name) Adds the name of a pack that is dependent on this pack.
void	addDependency(String name) Adds a dependency on another pack.
void	addFileSize(long add) Adds to the size of the pack.
void	addValidator(String validatorClassName) Adds a pack validator.
boolean	equals(Object obj)
List<String>	getChildren() Returns the children pack names.
String	getCondition() Returns the condition that must be fulfilled for the pack to be installed.
List<String>	getDependants() Returns the names of the pack that are dependent on this pack.
List<String>	getDependencies() Returns the pack's dependencies.
String	getDescription() Returns the pack description.
String	getExcludeGroup() Returns the exclude group for the pack.
long	getFileSize() Returns the size of the pack.
String	getGroup() Returns the pack group.
String	getImageId() Returns the pack image resource identifier.
Set<String>	getInstallGroups() Returns the installation groups that this pack belongs to.
String	getLangPackId() Returns the language pack identifier, used for internationalisation.
String	getName() Returns the pack name.
Map<String,String>	getOnDeselect()
Map<String,String>	getOnSelect()
List<OsModel>	getOsConstraints() Returns the target platforms for the pack.
String	getParent() Returns the parent pack name.
long	getSize() Returns the size of the pack.
List<String>	getValidators() Returns the pack validators.
boolean	hasChildren()
boolean	hasCondition() Determines if the pack has a condition for installation.
boolean	hasDependencies()
boolean	hasParent()
boolean	isHidden() Determines if the pack should be hidden.
boolean	isLoose() Determines if pack files are stored outside of the installation packages.
boolean	isPreselected() Determines if the pack should be preselected for installation.
boolean	isRequired() Determined if the pack is required.
boolean	isUninstall() Determines if the pack files are deleted at uninstallation.
void	setCondition(String condition) Sets a condition that must be fulfilled for the pack to be installed.
void	setDependants(List<String> dependants) Sets the names of the packs that require this pack.
void	setDependencies(List<String> dependencies) Sets the names of packs that this pack is dependent on.
void	setExcludeGroup(String group) Sets the exclude group for the pack.
void	setFileSize(long size) Sets the size of the pack.
void	setGroup(String group) Sets the pack group.
void	setHidden(boolean hidden) Determines if the pack should be hidden.
void	setImageId(String imageId) Sets the pack image resource identifier.
void	setLangPackId(String langPackId) Sets the language pack identifier, used for internationalisation.
void	setLoose(boolean loose) Determines if pack files are stored outside of the installation packages.
void	setOnDeselect(String names, String condition) Determines what packs to be selected or deselected when this pack is deselected.
void	setOnSelect(String names, String condition) Determines what packs to be selected or deselected when this pack is selected.
void	setOsConstraints(List<OsModel> platforms) Sets the target platforms for the pack.
void	setParent(String parent) Sets the parent pack name.
void	setPreselected(boolean preselected) Determines if the pack should be preselected for installation.
void	setSize(long size) Sets the size of the pack.
static String	toByteUnitsString(long bytes) Convert bytes into appropriate measurements.
String	toString() To a String (useful for JLists).

Methods inherited from class java.lang.Object

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

Constructor Detail

Pack

public Pack(String name,
            String langPackId,
            String description,
            List<OsModel> osConstraints,
            List<String> dependencies,
            boolean required,
            boolean preselected,
            boolean loose,
            String excludeGroup,
            boolean uninstall,
            long size)

The constructor.

Parameters:

name - the pack name. Uniquely identifies the pack

langPackId - the id of the pack used for I18N. May be null.

description - the pack description. May be null

osConstraints - the OS constraint. If null indicates the pack applies to all OSes

dependencies - dependencies of this pack. May be null

required - determines if the pack is required or not

preselected - if true the pack will be selected automatically for installation

loose - if true files of this pack are stored outside the installation jar file

excludeGroup - associated exclude group. May be null

uninstall - if true, the pack must be uninstalled

size - the pack size

Method Detail

getName

public String getName()

Returns the pack name. This uniquely identifies the pack.

Returns:

the pack name

setLangPackId

public void setLangPackId(String langPackId)

Sets the language pack identifier, used for internationalisation.

Parameters:

langPackId - the language pack identifier. May be null

getLangPackId

public String getLangPackId()

Returns the language pack identifier, used for internationalisation.

Returns:

the language pack identifier. May be null

getDescription

public String getDescription()

Returns the pack description.

Returns:

the pack description. May be null

setOsConstraints

public void setOsConstraints(List<OsModel> platforms)

Sets the target platforms for the pack.

Parameters:

platforms - the target platforms. If null or empty, indicates the pack applies to all platforms

getOsConstraints

public List<OsModel> getOsConstraints()

Returns the target platforms for the pack.

Returns:

the target platforms. If null or empty, indicates the pack applies to all platforms

setDependencies

public void setDependencies(List<String> dependencies)

Sets the names of packs that this pack is dependent on.

Parameters:

dependencies - a list of pack names. May be null

getDependencies

public List<String> getDependencies()

Returns the pack's dependencies.

Returns:

a list of pack names that the pack is dependent on. May be null

hasDependencies

public boolean hasDependencies()

addDependency

public void addDependency(String name)

Adds a dependency on another pack.

Parameters:

name - the name of the pack this pack is dependent on

setDependants

public void setDependants(List<String> dependants)

Sets the names of the packs that require this pack.

Parameters:

dependants - the dependants. May be null

getDependants

public List<String> getDependants()

Returns the names of the pack that are dependent on this pack.

Returns:

the dependants. May be null

addDependant

public void addDependant(String name)

Adds the name of a pack that is dependent on this pack.

Parameters:

name - the dependant pack name

isRequired

public boolean isRequired()

Determined if the pack is required.

Returns:

true if the pack is required; false if it is optional

setPreselected

public void setPreselected(boolean preselected)

Determines if the pack should be preselected for installation.

Parameters:

preselected - if true, the pack should be preselected

isPreselected

public boolean isPreselected()

Determines if the pack should be preselected for installation.

Returns:

true if the pack should be preselected

setLoose

public void setLoose(boolean loose)

Determines if pack files are stored outside of the installation packages.

Parameters:

loose - if true, pack files are stored outside of the installation packages

isLoose

public boolean isLoose()

Determines if pack files are stored outside of the installation packages.

Returns:

true if pack files are stored outside of the installation packages

setExcludeGroup

public void setExcludeGroup(String group)

Sets the exclude group for the pack. All packs in the same exclude group are mutually exclusive.

Parameters:

group - the exclude group. May be null

getExcludeGroup

public String getExcludeGroup()

Returns the exclude group for the pack.

Returns:

the exclude group. May be null

isUninstall

public boolean isUninstall()

Determines if the pack files are deleted at uninstallation.

Returns:

true if all files of the pack will be deleted during uninstallation; false if they should be retained (subject to the uninstaller force delete option)

getInstallGroups

public Set<String> getInstallGroups()

Returns the installation groups that this pack belongs to.

An installation group is a logical collection of packs. It enables different pack collections to be selected e.g. minimal, default, or all.

Returns:

the installation groups

setGroup

public void setGroup(String group)

Sets the pack group. This enables grouping of packs with related functionality.

Parameters:

group - the group. May be null

getGroup

public String getGroup()

Returns the pack group.

Returns:

the pack group. May be null

setSize

public void setSize(long size)

Sets the size of the pack.

Parameters:

size - the size of the pack, in bytes

getSize

public long getSize()

Returns the size of the pack.

Returns:

the size of the pack, in bytes

setFileSize

public void setFileSize(long size)

Sets the size of the pack.

Parameters:

size - the size of the pack, in bytes

addFileSize

public void addFileSize(long add)

Adds to the size of the pack.

Parameters:

add - the no. of bytes to add

getFileSize

public long getFileSize()

Returns the size of the pack.

Returns:

the size of the pack, in bytes

setParent

public void setParent(String parent)

Sets the parent pack name.

Parameters:

parent - the parent pack name. May be null

getParent

public String getParent()

Returns the parent pack name.

Returns:

the parent pack name. May be null

hasParent

public boolean hasParent()

Returns:

true if the pack has a parent otherwise false

addChild

public void addChild(String child)

Add a child to this pack.

getChildren

public List<String> getChildren()

Returns the children pack names.

Returns:

the names of the children for this pack.

hasChildren

public boolean hasChildren()

Returns:

true if the pack has a parent otherwise false

setImageId

public void setImageId(String imageId)

Sets the pack image resource identifier.

Parameters:

imageId - the image resource identifier. May be null

getImageId

public String getImageId()

Returns the pack image resource identifier.

Returns:

the resource identifier. If null, then the pack has no image

setCondition

public void setCondition(String condition)

Sets a condition that must be fulfilled for the pack to be installed.

Parameters:

condition - the condition to set. If null, indicates that installation is unconditional

getCondition

public String getCondition()

Returns the condition that must be fulfilled for the pack to be installed.

Returns:

the condition. If null, indicates that installation is unconditional

hasCondition

public boolean hasCondition()

Determines if the pack has a condition for installation.

Returns:

true if the pack has a condition, false if installation is unconditional

addValidator

public void addValidator(String validatorClassName)

Adds a pack validator.

Parameters:

validatorClassName - the pack validator class name

getValidators

public List<String> getValidators()

Returns the pack validators.

Returns:

the pack validator class names

setHidden

public void setHidden(boolean hidden)

Determines if the pack should be hidden.

Parameters:

hidden - true if the pack should be hidden, false if it should be displayed

isHidden

public boolean isHidden()

Determines if the pack should be hidden.

Returns:

true if the pack should be hidden, false if it should be displayed

toString

public String toString()

To a String (useful for JLists).

Overrides:

toString in class Object

Returns:

the string representation of the pack

toByteUnitsString

public static String toByteUnitsString(long bytes)

Convert bytes into appropriate measurements.

Parameters:

bytes - the bytes

Returns:

the string representation

setOnSelect

public void setOnSelect(String names,
                        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:

names - names of a pack to be selected/deselected separated by a comma

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

getOnSelect

public Map<String,String> getOnSelect()

setOnDeselect

public void setOnDeselect(String names,
                          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:

names - name of a pack to be selected/deselected separated by a comma

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

getOnDeselect

public Map<String,String> getOnDeselect()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object