Package jetbrains.buildServer.util

Class ZipReaderDecorator

java.lang.Object

jetbrains.buildServer.util.ZipReaderDecorator

All Implemented Interfaces:

Closeable, AutoCloseable, ZipReader

public class ZipReaderDecorator
extends Object
implements ZipReader

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ZipReaderDecorator(ZipReader target)

Method Summary

Modifier and Type	Method	Description
void	close()	Closes the opened zip file.
boolean	doesFileExist(String name)	Checks whether the specified file exists in the archive.
boolean	doesFileExist(Pattern namePattern)	Checks whether the file (specified by the given regular expression) exists in the archive.
long	getFileSize(String name)	Returns the size of the (uncompressed) file.
List<String>	listDirectoryFiles(String path)	Lists files that are in the specified directory.
List<String>	listFiles(Pattern regexPattern)	Lists files which names match the given pattern.
InputStream	openBinaryFile(String name)	Opens a binary file for read.
BufferedReader	openTextFile(String name, Charset charset)	Opens a text file for read.

Methods inherited from class java.lang.Object

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

Constructor Detail

ZipReaderDecorator

protected ZipReaderDecorator(@NotNull
                             ZipReader target)

Method Detail

listFiles

public List<String> listFiles(Pattern regexPattern)

Description copied from interface: ZipReader

Lists files which names match the given pattern.

Specified by:

listFiles in interface ZipReader

Parameters:

regexPattern - a file name pattern, applies to the path and file name. Note: the path units separator is always '/' (a unix slash). Mandatory.

Returns:

list of file names, ordered as the related files are placed in the archive file.

listDirectoryFiles

public List<String> listDirectoryFiles(String path)

Description copied from interface: ZipReader

Lists files that are in the specified directory.

For example, if the archive contains following files:

       aaa/xxx/f1.txt
       aaa/xxx/ttt/f2.txt
       aaa/yyy/f3.txt
   

We calling this function with "aaa/xxx", it will return:

       f1.txt
       ttt/f2.txt
   

Specified by:

listDirectoryFiles in interface ZipReader

Parameters:

path - directory path.

Returns:

list of file names related to the give path, ordered as the related files are placed in the archive file.

getFileSize

public long getFileSize(String name)

Description copied from interface: ZipReader

Returns the size of the (uncompressed) file.

Specified by:

getFileSize in interface ZipReader

Parameters:

name - file name.

Returns:

size of file, in bytes; or Long.MIN_VALUE if file doesn't exist.

openTextFile

@NotNull
public BufferedReader openTextFile(@NotNull
                                   String name,
                                   @Nullable
                                   Charset charset)
                            throws IOException

Description copied from interface: ZipReader

Opens a text file for read.

Specified by:

openTextFile in interface ZipReader

Parameters:

name - name of the file to open.

charset - desired character set, or null for using the default character set.

Returns:

text input stream.

Throws:

IOException

FileNotFoundException - if no entry with name has been found in the archive.

openBinaryFile

@NotNull
public InputStream openBinaryFile(@NotNull
                                  String name)
                           throws IOException

Description copied from interface: ZipReader

Opens a binary file for read.

Specified by:

openBinaryFile in interface ZipReader

Parameters:

name - name of the file to open.

Returns:

binary input stream.

Throws:

IOException

FileNotFoundException - if no entry with name has been found in the archive.

doesFileExist

public boolean doesFileExist(@NotNull
                             String name)

Description copied from interface: ZipReader

Checks whether the specified file exists in the archive.

Specified by:

doesFileExist in interface ZipReader

Parameters:

name - name of the file to check for existence.

Returns:

file exists.

doesFileExist

public boolean doesFileExist(@NotNull
                             Pattern namePattern)

Description copied from interface: ZipReader

Checks whether the file (specified by the given regular expression) exists in the archive.

Specified by:

doesFileExist in interface ZipReader

Returns:

file exists.

close

public void close()

Description copied from interface: ZipReader

Closes the opened zip file.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Specified by:

close in interface ZipReader