io.codechicken.diffpatch.util

Class Output.MultiOutput

java.lang.Object

io.codechicken.diffpatch.util.Output

io.codechicken.diffpatch.util.Output.MultiOutput

All Implemented Interfaces:

java.lang.AutoCloseable

Direct Known Subclasses:

Output.ArchiveMultiOutput, Output.FolderMultiOutput

Enclosing class:

Output

public abstract static class Output.MultiOutput
extends Output
implements java.lang.AutoCloseable

Represents an output capable of receiving multiple files, such as an Archive or a Folder.

Nested Class Summary

Nested classes/interfaces inherited from class io.codechicken.diffpatch.util.Output

Output.ArchiveMultiOutput, Output.FolderMultiOutput, Output.MultiOutput, Output.PathArchiveMultiOutput, Output.PipeArchiveMultiOutput, Output.SingleOutput

Constructor Summary

Constructors

Constructor and Description
MultiOutput()

Method Summary

Modifier and Type	Method and Description
static Output.MultiOutput	archive(ArchiveFormat format, java.io.OutputStream stream) Create a Output.MultiOutput which writes an archive to the given stream.
static Output.MultiOutput	archive(ArchiveFormat format, java.nio.file.Path path) Create a Output.MultiOutput which writes an archive to a file.
abstract void	close()
static Output.MultiOutput	detectedArchive(java.nio.file.Path path) Create a Output.MultiOutput which writes an archive to a file.
static Output.MultiOutput	folder(java.nio.file.Path output) Create a Output.MultiOutput which writes an archive to a folder.
abstract void	open(boolean clearOutput) Called to open any internal resources and set up the output for writing.
abstract void	write(java.lang.String path, byte[] data) Called to write a file to the output.

Methods inherited from class io.codechicken.diffpatch.util.Output

isSamePath, validate

Methods inherited from class java.lang.Object

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

Constructor Detail

MultiOutput

public MultiOutput()

Method Detail

archive

public static Output.MultiOutput archive(ArchiveFormat format,
                                         java.nio.file.Path path)

Create a Output.MultiOutput which writes an archive to a file.

Parameters:

format - The format of the archive.

path - The destination.

Returns:

The output.

detectedArchive

public static Output.MultiOutput detectedArchive(java.nio.file.Path path)
                                          throws java.lang.IllegalArgumentException

Create a Output.MultiOutput which writes an archive to a file.

Will attempt to automatically detect the archive format based on file name.

If the format can not be detected it will throw a IllegalArgumentException

Parameters:

path - The path.

Returns:

The output.

Throws:

java.lang.IllegalArgumentException - If the format cannot be detected.

archive

public static Output.MultiOutput archive(ArchiveFormat format,
                                         java.io.OutputStream stream)

Create a Output.MultiOutput which writes an archive to the given stream.

Parameters:

format - The format of the archive.

stream - The destination.

Returns:

The output.

folder

public static Output.MultiOutput folder(java.nio.file.Path output)

Create a Output.MultiOutput which writes an archive to a folder.

Parameters:

output - The destination folder.

Returns:

The output.

open

public abstract void open(boolean clearOutput)
                   throws java.io.IOException

Called to open any internal resources and set up the output for writing.

Parameters:

clearOutput - If the output should be wiped, or written over top of. This only effects Output.FolderMultiOutput. Archives are always rewritten.

Throws:

java.io.IOException

write

public abstract void write(java.lang.String path,
                           byte[] data)
                    throws java.io.IOException

Called to write a file to the output.

Parameters:

path - The relative path of the output. Will not contain a starting slash.

data - The data.

Throws:

java.io.IOException

close

public abstract void close()
                    throws java.io.IOException

Specified by:

close in interface java.lang.AutoCloseable

Throws:

java.io.IOException