org.apache.aries.util.filesystem.impl

Class NestedZipDirectory

java.lang.Object

org.apache.aries.util.filesystem.impl.NestedZipFile

org.apache.aries.util.filesystem.impl.NestedZipDirectory

All Implemented Interfaces:

Iterable<IFile>, IDirectory, IFile

public class NestedZipDirectory
extends NestedZipFile
implements IDirectory

Constructor Summary

Constructors

Constructor and Description
NestedZipDirectory(IFile archive)
NestedZipDirectory(IFile archive, String pathInZip, NestedZipDirectory parent, NestedCloseableDirectory cache)
NestedZipDirectory(IFile archive, ZipEntry entry, NestedZipDirectory parent, NestedCloseableDirectory cache)
NestedZipDirectory(NestedZipDirectory other, NestedCloseableDirectory cache)

Method Summary

Modifier and Type	Method and Description
IDirectory	convert()
IFile	getFile(String name) Gets the requested file under this directory.
boolean	isDirectory()
boolean	isFile()
boolean	isRoot()
Iterator<IFile>	iterator()
List<IFile>	listAllFiles()
List<IFile>	listFiles()
InputStream	open() The input stream returned by this method should always be closed after use.
ICloseableDirectory	toCloseable() Open a more effective implementation with user regulated resource management.

Methods inherited from class org.apache.aries.util.filesystem.impl.NestedZipFile

convertNested, equals, getLastModified, getName, getNameInZip, getParent, getRoot, getSize, hashCode, toString, toURL

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Methods inherited from interface org.apache.aries.util.filesystem.IFile

convertNested, getLastModified, getName, getParent, getRoot, getSize, toURL

Constructor Detail

NestedZipDirectory

public NestedZipDirectory(IFile archive,
                          ZipEntry entry,
                          NestedZipDirectory parent,
                          NestedCloseableDirectory cache)

NestedZipDirectory

public NestedZipDirectory(IFile archive,
                          String pathInZip,
                          NestedZipDirectory parent,
                          NestedCloseableDirectory cache)

NestedZipDirectory

public NestedZipDirectory(IFile archive)

NestedZipDirectory

public NestedZipDirectory(NestedZipDirectory other,
                          NestedCloseableDirectory cache)

Method Detail

convert

public IDirectory convert()

Specified by:

convert in interface IFile

Overrides:

convert in class NestedZipFile

Returns:

if this is a directory return this as an IDirectory, otherwise return null.

iterator

public Iterator<IFile> iterator()

Specified by:

iterator in interface Iterable<IFile>

listFiles

public List<IFile> listFiles()

Specified by:

listFiles in interface IDirectory

Returns:

the list of files in this directory. Files must be in this directory and not in sub-directories.

listAllFiles

public List<IFile> listAllFiles()

Specified by:

listAllFiles in interface IDirectory

Returns:

the list of files in all directories (including sub-directories). This is the complete list.

getFile

public IFile getFile(String name)

Description copied from interface: IDirectory

Gets the requested file under this directory. The file may be located any number of levels within this directory. The name is relative to this directory. If the file cannot be found it will return null.

Specified by:

getFile in interface IDirectory

Parameters:

name - the name of the file.

Returns:

the IFile, or null if no such file exists.

isDirectory

public boolean isDirectory()

Specified by:

isDirectory in interface IFile

Overrides:

isDirectory in class NestedZipFile

Returns:

true iff this IFile is also an IDirectory

open

public InputStream open()
                 throws IOException,
                        UnsupportedOperationException

Description copied from interface: IFile

The input stream returned by this method should always be closed after use.

Specified by:

open in interface IFile

Overrides:

open in class NestedZipFile

Returns:

An InputStream to read the file from.

Throws:

IOException

UnsupportedOperationException - If the IFile is also an IDirectory.

isFile

public boolean isFile()

Specified by:

isFile in interface IFile

Overrides:

isFile in class NestedZipFile

Returns:

true iff this IFile is not an IDirectory

isRoot

public boolean isRoot()

Specified by:

isRoot in interface IDirectory

Returns:

true if this IDirectory is the root of the virtual file system.

toCloseable

public ICloseableDirectory toCloseable()

Description copied from interface: IDirectory

Open a more effective implementation with user regulated resource management. The implementation will be more efficient for batch operations. Make sure to call close when finished with the returned IDirectory. IFiles and IDirectories other than the returned closeable directory will stay valid after calling the close method but will no longer perform as efficiently. InputStreams that are open at the time of calling close may be invalidated.

Specified by:

toCloseable in interface IDirectory

Returns:

ICloseableDirectory or null if a batch aware version of this IDirectory is not supported