Package org.apache.jackrabbit.vault.fs.io

Class ZipArchive

java.lang.Object

org.apache.jackrabbit.vault.fs.io.ZipArchive

All Implemented Interfaces:

Closeable, AutoCloseable, Archive

public class ZipArchive
extends Object

Implements an archive that is based on a zip file.

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.jackrabbit.vault.fs.io.Archive

Archive.Entry

Constructor Summary

Constructors

Constructor	Description
ZipArchive(File zipFile)	Creates a new archive that is based on the given zip file.
ZipArchive(File zipFile, boolean isTempFile)	Creates a new archive that is based on the given zip file.

Method Summary

Modifier and Type	Method	Description
void	close()	closes the archive
Archive.Entry	getEntry(String path)	Returns the entry specified by path.
File	getFile()	Returns the underlying file or null if it does not exist.
long	getFileSize()	Returns the size of the underlying file or -1 if it does not exist.
VaultInputSource	getInputSource(Archive.Entry entry)	Returns an input source for the given entry
Archive.Entry	getJcrRoot()	Returns the entry that specifies the "jcr_root".
MetaInf	getMetaInf()	Returns the meta inf.
Archive.Entry	getRoot()	Returns the root entry.
Archive	getSubArchive(String rootPath, boolean asJcrRoot)	Returns a sub archive that is rooted at the given path.
void	open(boolean strict)	Opens the archive.
InputStream	openInputStream(Archive.Entry entry)	Opens an input stream for the given entry
String	toString()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ZipArchive

public ZipArchive(@Nonnull
                  File zipFile)

Creates a new archive that is based on the given zip file.

Parameters:

zipFile - the zip file

ZipArchive

public ZipArchive(@Nonnull
                  File zipFile,
                  boolean isTempFile)

Creates a new archive that is based on the given zip file.

Parameters:

zipFile - the zip file

isTempFile - if true if the file is considered temporary and can be deleted after this archive is closed.

Method Detail

open

public void open(boolean strict)
          throws IOException

Description copied from interface: Archive

Opens the archive.

Parameters:

strict - if true open will fail if there was an internal error while parsing meta data.

Throws:

IOException - if an error occurs

openInputStream

@Nullable
public InputStream openInputStream(@Nullable
                                   Archive.Entry entry)
                            throws IOException

Description copied from interface: Archive

Opens an input stream for the given entry

Parameters:

entry - the entry

Returns:

the input stream or null if the entry can't be read

Throws:

IOException - if an error occurs

getInputSource

@Nullable
public VaultInputSource getInputSource(@Nullable
                                       Archive.Entry entry)
                                throws IOException

Description copied from interface: Archive

Returns an input source for the given entry

Parameters:

entry - the entry

Returns:

the input source or null if the entry can't be read

Throws:

IOException - if an error occurs

close

public void close()

Description copied from interface: Archive

closes the archive

getRoot

@Nonnull
public Archive.Entry getRoot()
                      throws IOException

Description copied from interface: Archive

Returns the root entry.

Returns:

the root entry.

Throws:

IOException - if an error occurs

getMetaInf

@Nonnull
public MetaInf getMetaInf()

Description copied from interface: Archive

Returns the meta inf. If the archive provides no specific meta data, a default, empty meta inf is returned.

Returns:

the meta inf.

getFile

@Nullable
public File getFile()

Returns the underlying file or null if it does not exist.

Returns:

the file or null.

getFileSize

public long getFileSize()

Returns the size of the underlying file or -1 if it does not exist.

Returns:

the file size

toString

public String toString()

Overrides:

toString in class Object

getEntry

public Archive.Entry getEntry(String path)
                       throws IOException

Description copied from interface: Archive

Returns the entry specified by path.

Specified by:

getEntry in interface Archive

Parameters:

path - the path

Returns:

the entry or null if not found.

Throws:

IOException - if an error occurs

getJcrRoot

public Archive.Entry getJcrRoot()
                         throws IOException

Description copied from interface: Archive

Returns the entry that specifies the "jcr_root". if no such entry exists, null is returned.

Specified by:

getJcrRoot in interface Archive

Returns:

the jcr_root entry or null

Throws:

IOException - if an error occurs

getSubArchive

public Archive getSubArchive(String rootPath,
                             boolean asJcrRoot)
                      throws IOException

Description copied from interface: Archive

Returns a sub archive that is rooted at the given path. Note that sub archives currently can't have they own meta inf and are closed automatically if they base is closed.

Specified by:

getSubArchive in interface Archive

Parameters:

rootPath - root path

asJcrRoot - if true the given root is the jcr_root

Returns:

the archive or null if entry specified by root does not exist.

Throws:

IOException - if an error occurs