com.github.wuic.path.core

Class ZipFilePath

java.lang.Object

com.github.wuic.path.core.SimplePath

com.github.wuic.path.AbstractDirectoryPath

com.github.wuic.path.core.ZipDirectoryPath

com.github.wuic.path.core.ZipFilePath

All Implemented Interfaces:

DirectoryPath, FilePath, Path

public class ZipFilePath
extends ZipDirectoryPath
implements FilePath, DirectoryPath

This class represents a path which could be considered as a FilePath and as a DirectoryPath with a ZIP archive behind the scene. It is a directory since we can consider its entries as children and a path since we can directly read the archive.

Since:

0.3.4

Version:

1.1

Author:

Guillaume DROUET

Constructor Summary

Constructors

Constructor and Description
ZipFilePath(File file, DirectoryPath parent) Builds a new instance with the file name as path name.
ZipFilePath(File file, String name, DirectoryPath parent) Builds a new instance.

Method Summary

Methods

Modifier and Type	Method and Description
protected String	absoluteEntryOf(String child) Gets the absolute entry name of the given String built relatively to this directory's archive.
long	getLastUpdate() Gets the last update date of this path.
File	getRawFile() Gets the concrete path pointing to the archive on path system.
protected ZipFile	getZipFile() Gets the ZIP file related to this directory.
String[]	list() Lists all the children path names of this directory.
String[]	list(String baseEntry) Lists all the entries in the archive relatively to the given root entry name.
InputStream	openStream() Opens a stream to the path represented by this path.

Methods inherited from class com.github.wuic.path.core.ZipDirectoryPath

buildChild

Methods inherited from class com.github.wuic.path.AbstractDirectoryPath

getChild

Methods inherited from class com.github.wuic.path.core.SimplePath

getAbsolutePath, getName, getParent, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.github.wuic.path.DirectoryPath

getChild

Methods inherited from interface com.github.wuic.path.Path

getAbsolutePath, getName, getParent

Constructor Detail

ZipFilePath

public ZipFilePath(File file,
           DirectoryPath parent)
            throws IOException

Builds a new instance with the file name as path name.

Parameters:

file - the path

parent - the parent

Throws:

IOException - if any I/O error occurs

ZipFilePath

public ZipFilePath(File file,
           String name,
           DirectoryPath parent)
            throws IOException

Builds a new instance. Throws an IllegalArgumentException if the given path is not a ZIP archive.

Parameters:

file - the path

name - the name

parent - the parent

Throws:

IOException - if any I/O error occurs

Method Detail

getRawFile

public File getRawFile()

Gets the concrete path pointing to the archive on path system.

Returns:

the raw path

openStream

public InputStream openStream()
                       throws IOException

Opens a stream to the path represented by this path.

Specified by:

openStream in interface FilePath

Returns:

the stream

Throws:

IOException - if stream can't be opened

list

public String[] list()
              throws IOException

Lists all the children path names of this directory.

Specified by:

list in interface DirectoryPath

Returns:

the children path names

Throws:

IOException - if any I/O error occurs

list

public String[] list(String baseEntry)
              throws IOException

Lists all the entries in the archive relatively to the given root entry name.

Parameters:

baseEntry - the root entry

Returns:

the entries which are children of the root entry

Throws:

IOException - if any I/O error occurs

getZipFile

protected ZipFile getZipFile()
                      throws IOException

Gets the ZIP file related to this directory.

Specified by:

getZipFile in class ZipDirectoryPath

Returns:

the ZIP file

Throws:

IOException - if any I/O error occurs

getLastUpdate

public long getLastUpdate()

Gets the last update date of this path.

Specified by:

getLastUpdate in interface Path

Returns:

a date representing the date when this path was updated

absoluteEntryOf

protected String absoluteEntryOf(String child)
                          throws IOException

Gets the absolute entry name of the given String built relatively to this directory's archive.

Specified by:

absoluteEntryOf in class ZipDirectoryPath

Returns:

the ZIP file

Throws:

IOException - if any I/O error occurs