Package jetbrains.buildServer.util

Class ZipWriterDecorator

java.lang.Object

jetbrains.buildServer.util.ZipWriterDecorator

All Implemented Interfaces:

Closeable, AutoCloseable, ZipWriter

public class ZipWriterDecorator
extends Object
implements ZipWriter

Created by Nikita.Skvortsov date: 14.08.2014.

Constructor Summary

Constructors

Constructor	Description
ZipWriterDecorator(ZipWriter delegate)

Method Summary

Modifier and Type	Method	Description
void	close()
OutputStream	createBinaryFile(String name)	Creates a binary output stream to write into an archive.
OutputStream	createBinaryFile(String name, long mtimeMillis)	Creates a new ZIP entry to store binary data and returns an OutputStream to it.
Writer	createTextFile(String name, Charset charset)	Creates a text output stream to write into an archive.
Writer	createTextFile(String name, Charset charset, long mtimeMillis)	Creates a new ZIP entry to store plain text data and returns a Writer to it.
void	setArchiveComment(String comment)	Writes a comment to the archive.

Methods inherited from class java.lang.Object

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

Constructor Detail

ZipWriterDecorator

public ZipWriterDecorator(@NotNull
                          ZipWriter delegate)

Method Detail

setArchiveComment

public final void setArchiveComment(@Nullable
                                    String comment)
                             throws IOException

Description copied from interface: ZipWriter

Writes a comment to the archive.

Specified by:

setArchiveComment in interface ZipWriter

Parameters:

comment - the text to write as a comment.

Throws:

IOException - fail.

createTextFile

@NotNull
public Writer createTextFile(@NotNull
                             String name,
                             @Nullable
                             Charset charset)
                      throws IOException

Description copied from interface: ZipWriter

Creates a text output stream to write into an archive. The character code table depends on the implementation.

Specified by:

createTextFile in interface ZipWriter

Parameters:

name - file name (relative to the archive root).

charset - character set to use for this file, or null for use default character set.

Returns:

text output stream.

Throws:

IOException

See Also:

ZipWriter.createTextFile(String, Charset, long)

createTextFile

@NotNull
public Writer createTextFile(@NotNull
                             String name,
                             @Nullable
                             Charset charset,
                             long mtimeMillis)
                      throws IOException

Description copied from interface: ZipWriter

Creates a new ZIP entry to store plain text data and returns a Writer to it. It's the client's responsibility to close the returned Writer.

Specified by:

createTextFile in interface ZipWriter

Parameters:

name - the name of the ZIP entry to create (relative path with forward slashes (/)).

charset - the optional character set to use, or null if the default character set is to be used.

mtimeMillis - the entry's modification time (@{code mtime}), in milliseconds since epoch.

Returns:

the Writer pointing to the newly created ZIP entry. The Writer is already buffered, to there's no need to wrap it into a BufferedWriter.

Throws:

ZipException - if a ZIP stream error occurs.

IOException - if any other I/O error occurs.

See Also:

ZipWriter.createTextFile(String, Charset)

createBinaryFile

@NotNull
public OutputStream createBinaryFile(@NotNull
                                     String name)
                              throws IOException

Description copied from interface: ZipWriter

Creates a binary output stream to write into an archive.

Specified by:

createBinaryFile in interface ZipWriter

Parameters:

name - file name (relative to the archive root).

Returns:

binary output stream.

Throws:

IOException

See Also:

ZipWriter.createBinaryFile(String, long)

createBinaryFile

@NotNull
public OutputStream createBinaryFile(@NotNull
                                     String name,
                                     long mtimeMillis)
                              throws IOException

Description copied from interface: ZipWriter

Creates a new ZIP entry to store binary data and returns an OutputStream to it. It's the client's responsibility to close the returned OutputStream.

Specified by:

createBinaryFile in interface ZipWriter

Parameters:

name - the name of the ZIP entry to create (relative path with forward slashes (/)).

mtimeMillis - the entry's modification time (@{code mtime}), in milliseconds since epoch.

Returns:

the OutputStream pointing to the newly created ZIP entry. The OutputStream is already buffered, to there's no need to wrap it into a BufferedOutputStream.

Throws:

ZipException - if a ZIP stream error occurs.

IOException - if any other I/O error occurs.

See Also:

ZipWriter.createBinaryFile(String)

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Throws:

IOException