com.izforge.izpack.api.data

Class PackFile

java.lang.Object

com.izforge.izpack.api.data.PackFile

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

XPackFile

public class PackFile
extends Object
implements Serializable

Encloses information about a packed file. This class abstracts the way file data is stored to package.

Author:

Johannes Lehtinen

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
PackFile(File baseDir, File src, String target, List<OsModel> osList, OverrideType override, String overrideRenameTo, Blockable blockable, Map<String,String> pack200Properties) Constructs and initializes from a source file.
PackFile(File baseDir, File src, String target, List<OsModel> osList, OverrideType override, String overrideRenameTo, Blockable blockable, Map additionals, Map<String,String> pack200Properties) Constructs and initializes from a source file.
PackFile(File src, String relativeSourcePath, String target, List<OsModel> osList, OverrideType override, String overrideRenameTo, Blockable blockable, Map additionals, Map<String,String> pack200Properties) Constructs and initializes from a source file.

Method Summary

Modifier and Type	Method and Description
Blockable	blockable() Whether or not this file might be blocked during installation/uninstallation
Map	getAdditionals() Returns the additionals map.
String	getCondition()
File	getFile() The packed file object
int	getId() Get the unique ID compiled into this object
PackFile	getLinkedPackFile()
Map<String,String>	getPack200Properties()
String	getRelativeSourcePath() The Path of the file relative to the given (compiletime's) basedirectory.
long	getStreamOffset()
String	getStreamResourceName()
String	getTargetPath() The full path name of the target file, using '/' as fileseparator.
boolean	hasCondition()
boolean	isBackReference()
boolean	isDirectory()
boolean	isPack200Jar()
long	lastModified() The last-modification time of the file.
long	length() The length of the file in bytes
List<OsModel>	osConstraints() The target operating system constraints of this file
OverrideType	override() Whether or not this file is going to override any existing ones
String	overrideRenameTo() Returns globmapper expression for mapping the resulting file name if overriding is allowed and the file does already exist.
void	setCondition(String condition)
void	setLinkedPackFile(PackFile linkedPackFile)
void	setLoosePackInfo(boolean loose)
void	setSize(long size) Override the acutal packed file size (after compressing)
void	setStreamOffset(long offset)
void	setStreamResourceName(String streamResourceName)
long	size() The size of the file in bytes (is the same as the length if it is not a loose pack)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

PackFile

public PackFile(File baseDir,
                File src,
                String target,
                List<OsModel> osList,
                OverrideType override,
                String overrideRenameTo,
                Blockable blockable,
                Map<String,String> pack200Properties)
         throws IOException

Constructs and initializes from a source file.

Parameters:

baseDir - the baseDirectory of the Fileselection/compilation or null

src - file which this PackFile describes

target - the path to install the file to

osList - OS constraints

override - what to do when the file already exists

Throws:

FileNotFoundException - if the specified file does not exist.

IOException

PackFile

public PackFile(File src,
                String relativeSourcePath,
                String target,
                List<OsModel> osList,
                OverrideType override,
                String overrideRenameTo,
                Blockable blockable,
                Map additionals,
                Map<String,String> pack200Properties)
         throws FileNotFoundException

Constructs and initializes from a source file.

Parameters:

src - file which this PackFile describes

relativeSourcePath - the path relative to the compiletime's basedirectory, use computeRelativePathFrom(File, File) to compute this.

target - the path to install the file to

osList - OS constraints

override - what to do when the file already exists

additionals - additional attributes

Throws:

FileNotFoundException - if the specified file does not exist.

PackFile

public PackFile(File baseDir,
                File src,
                String target,
                List<OsModel> osList,
                OverrideType override,
                String overrideRenameTo,
                Blockable blockable,
                Map additionals,
                Map<String,String> pack200Properties)
         throws IOException

Constructs and initializes from a source file.

Parameters:

baseDir - The Base directory that is used to search for the files. This is used to build the relative path's

src - file which this PackFile describes

target - the path to install the file to

osList - OS constraints

override - what to do when the file already exists

additionals - additional attributes

Throws:

FileNotFoundException - if the specified file does not exist.

IOException

Method Detail

getId

public int getId()

Get the unique ID compiled into this object

Returns:

the unique ID

getLinkedPackFile

public PackFile getLinkedPackFile()

setLinkedPackFile

public void setLinkedPackFile(PackFile linkedPackFile)

getStreamResourceName

public String getStreamResourceName()

setStreamResourceName

public void setStreamResourceName(String streamResourceName)

getStreamOffset

public long getStreamOffset()

setStreamOffset

public void setStreamOffset(long offset)

osConstraints

public final List<OsModel> osConstraints()

The target operating system constraints of this file

getFile

public final File getFile()

The packed file object

length

public final long length()

The length of the file in bytes

size

public final long size()

The size of the file in bytes (is the same as the length if it is not a loose pack)

setSize

public void setSize(long size)

Override the acutal packed file size (after compressing)

Parameters:

size - the size in bytes

lastModified

public final long lastModified()

The last-modification time of the file.

override

public final OverrideType override()

Whether or not this file is going to override any existing ones

overrideRenameTo

public final String overrideRenameTo()

Returns globmapper expression for mapping the resulting file name if overriding is allowed and the file does already exist. This is similar like the Ant globmapper target expression when mapping from "*".

Returns:

mapper pattern

blockable

public final Blockable blockable()

Whether or not this file might be blocked during installation/uninstallation

isDirectory

public final boolean isDirectory()

isBackReference

public final boolean isBackReference()

getTargetPath

public final String getTargetPath()

The full path name of the target file, using '/' as fileseparator.

getRelativeSourcePath

public String getRelativeSourcePath()

The Path of the file relative to the given (compiletime's) basedirectory. Can be resolved while installing with either current working directory or directory of "installer.jar"

getAdditionals

public Map getAdditionals()

Returns the additionals map.

Returns:

additionals

getCondition

public String getCondition()

Returns:

the condition

setCondition

public void setCondition(String condition)

Parameters:

condition - the condition to set

hasCondition

public boolean hasCondition()

isPack200Jar

public boolean isPack200Jar()

getPack200Properties

public Map<String,String> getPack200Properties()

setLoosePackInfo

public void setLoosePackInfo(boolean loose)

toString

public String toString()

Overrides:

toString in class Object