Package com._1c.g5.v8.dt.export

Class ZipArchiveBuilder

java.lang.Object

com._1c.g5.v8.dt.export.ZipArchiveBuilder

All Implemented Interfaces:

IExportArtifactBuilder, Closeable, AutoCloseable

public final class ZipArchiveBuilder
extends Object
implements IExportArtifactBuilder

An implementation of IExportArtifactBuilder that writes data to a zip-file.

Method Summary

Modifier and Type	Method	Description
void	close()
void	copy(Path sourcePath, Path targetPath)	Copies a file or directory residing on the local file system into the artifact.
static ZipArchiveBuilder	create(OutputStream outputStream, int level, long maxQueuedDataSize)	Creates a new builder.
static ZipArchiveBuilder	create(Path path, int level, long maxQueuedDataSize)	Creates a new builder.
OutputStream	newOutputStream(Path path)	Creates an output stream for writing a file inside the artifact.

Methods inherited from class java.lang.Object

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

Method Details

create

public static ZipArchiveBuilder create(Path path,
 int level,
 long maxQueuedDataSize)
                                throws IOException

Creates a new builder.

Parameters:

path - The path of the target zip-file. May not be null.

level - The compression level, a number between 0 (best speed) and 9 (best compression).

maxQueuedDataSize - The maximum queued data size in bytes. Must be greater than 0.

Returns:

a new zip-file builder. Never null.

Throws:

IOException - if any I/O error occurs.

create

public static ZipArchiveBuilder create(OutputStream outputStream,
 int level,
 long maxQueuedDataSize)
                                throws IOException

Creates a new builder.

Parameters:

outputStream - The target output stream. May not be null.

level - The compression level, a number between 0 (best speed) and 9 (best compression).

maxQueuedDataSize - The maximum queued data size in bytes. Must be greater than 0.

Returns:

a new zip-file builder. Never null.

Throws:

IOException - if any I/O error occurs.

newOutputStream

public OutputStream newOutputStream(Path path)
                             throws IOException

Description copied from interface: IExportArtifactBuilder

Creates an output stream for writing a file inside the artifact. All nonexistent directories are created automatically. The returned stream does not need wrapping into BufferedOutputStream. If the given path already exists, the behavior of this method is not defined.

Specified by:

newOutputStream in interface IExportArtifactBuilder

Parameters:

path - The path to the file inside the artifact. May not be null.

Returns:

a new output stream. Never null.

Throws:

IOException - if any I/O error occurs.

copy

public void copy(Path sourcePath,
 Path targetPath)
          throws IOException

Description copied from interface: IExportArtifactBuilder

Copies a file or directory residing on the local file system into the artifact. All nonexistent directories are created automatically. If the given target path already exists, the behavior of this method is not defined.

Specified by:

copy in interface IExportArtifactBuilder

Parameters:

sourcePath - The path of the source file or directory residing on the local file system. May not be null.

targetPath - The path of the target file or directory inside the artifact. May not be null.

Throws:

IOException - if any I/O error occurs.

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Throws:

IOException