Package com.sun.tools.javac.file

Class ZipFileIndex

java.lang.Object

com.sun.tools.javac.file.ZipFileIndex

public class ZipFileIndex
extends Object

This class implements the building of index of a zip archive and access to its context. It also uses a prebuilt index if available. It supports invocations where it will serialize an optimized zip index file to disk. In order to use a secondary index file, set "usezipindex" in the Options object when JavacFileManager is invoked. (You can pass "-XDusezipindex" on the command line.) Location where to look for/generate optimized zip index files can be provided using "-XDcachezipindexdir=<directory>". If this flag is not provided, the default location is the value of the "java.io.tmpdir" system property. If "-XDwritezipindexfiles" is specified, there will be new optimized index file created for each archive, used by the compiler for compilation, at the location specified by the "cachezipindexdir" option. If system property nonBatchMode option is specified the compiler will use timestamp checking to reindex the zip files if it is needed. In batch mode the timestamps are not checked and the compiler uses the cached indexes.

This is NOT part of any supported API. If you write code that depends on this, you do so at your own risk. This code and its internal interfaces are subject to change or deletion without notice.

Field Summary

Fields

Modifier and Type	Field and Description
static long	NOT_MODIFIED

Method Summary

Modifier and Type	Method and Description
void	close()
boolean	contains(RelativePath path) Tests if a specific path exists in the zip.
protected void	finalize()
Set<RelativePath.RelativeDirectory>	getAllDirectories()
List<String>	getDirectories(RelativePath.RelativeDirectory path)
List<String>	getFiles(RelativePath.RelativeDirectory path) Returns a javac List of filenames within a directory in the ZipFileIndex.
long	getLastModified(RelativePath.RelativeFile path)
File	getZipFile()
long	getZipFileLastModified() Returns the last modified timestamp of a zip file.
boolean	isDirectory(RelativePath path)
boolean	isOpen()
int	length(RelativePath.RelativeFile path)
byte[]	read(RelativePath.RelativeFile path)
int	read(RelativePath.RelativeFile path, byte[] buffer)
String	toString()
boolean	writeZipIndex()

Methods inherited from class java.lang.Object

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

Field Detail

NOT_MODIFIED

public static final long NOT_MODIFIED

See Also:

Constant Field Values

Method Detail

isOpen

public boolean isOpen()

toString

public String toString()

Overrides:

toString in class Object

finalize

protected void finalize()
                 throws Throwable

Overrides:

finalize in class Object

Throws:

Throwable

close

public void close()

getFiles

public List<String> getFiles(RelativePath.RelativeDirectory path)

Returns a javac List of filenames within a directory in the ZipFileIndex.

getDirectories

public List<String> getDirectories(RelativePath.RelativeDirectory path)

getAllDirectories

public Set<RelativePath.RelativeDirectory> getAllDirectories()

contains

public boolean contains(RelativePath path)

Tests if a specific path exists in the zip. This method will return true for file entries and directories.

Parameters:

path - A path within the zip.

Returns:

True if the path is a file or dir, false otherwise.

isDirectory

public boolean isDirectory(RelativePath path)
                    throws IOException

Throws:

IOException

getLastModified

public long getLastModified(RelativePath.RelativeFile path)
                     throws IOException

Throws:

IOException

length

public int length(RelativePath.RelativeFile path)
           throws IOException

Throws:

IOException

read

public byte[] read(RelativePath.RelativeFile path)
            throws IOException

Throws:

IOException

read

public int read(RelativePath.RelativeFile path,
                byte[] buffer)
         throws IOException

Throws:

IOException

getZipFileLastModified

public long getZipFileLastModified()
                            throws IOException

Returns the last modified timestamp of a zip file.

Returns:

long

Throws:

IOException

writeZipIndex

public boolean writeZipIndex()

getZipFile

public File getZipFile()