io.codechicken.diffpatch.util

Class Input.MultiInput

java.lang.Object

io.codechicken.diffpatch.util.Input

io.codechicken.diffpatch.util.Input.MultiInput

All Implemented Interfaces:

java.lang.AutoCloseable

Direct Known Subclasses:

Input.ArchiveMultiInput, Input.FolderMultiInput

Enclosing class:

Input

public abstract static class Input.MultiInput
extends Input
implements java.lang.AutoCloseable

Represents an input capable or providing multiple files, such as an Archive or a Folder.

Nested Class Summary

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

Input.ArchiveMultiInput, Input.FolderMultiInput, Input.MultiInput, Input.PathArchiveMultiInput, Input.PipeArchiveMultiInput, Input.SingleInput

Constructor Summary

Constructors

Constructor and Description
MultiInput()

Method Summary

Modifier and Type	Method and Description
static Input.MultiInput	archive(ArchiveFormat format, byte[] bytes) Create a Input.MultiInput which reads from an array of bytes.
static Input.MultiInput	archive(ArchiveFormat format, java.io.InputStream stream) Create a Input.MultiInput which reads from an existing stream.
static Input.MultiInput	archive(ArchiveFormat format, java.nio.file.Path path) Create a Input.MultiInput which reads from an archive file.
abstract void	close()
static Input.MultiInput	detectedArchive(java.nio.file.Path path) Create a Input.MultiInput which reads from an archive file.
static Input.MultiInput	folder(java.nio.file.Path folder) Create a Input.MultiInput which reads from a folder.
abstract java.util.Set<java.lang.String>	index() Get the index for this input.
abstract void	open(java.lang.String prefix) Called to open any internal resources and set up the input for reading.
byte[]	read(java.lang.String key) Read the given entry as an array of bytes.
java.util.List<java.lang.String>	readLines(java.lang.String key) Read the given entry as a List of Strings.
abstract byte[]	tryRead(java.lang.String key) Try and read the given entry as an array of bytes.

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

validate

Methods inherited from class java.lang.Object

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

Constructor Detail

MultiInput

public MultiInput()

Method Detail

archive

public static Input.MultiInput archive(ArchiveFormat format,
                                       java.nio.file.Path path)

Create a Input.MultiInput which reads from an archive file.

Parameters:

format - The format of the archive.

path - The path.

Returns:

The input.

detectedArchive

public static Input.MultiInput detectedArchive(java.nio.file.Path path)
                                        throws java.lang.IllegalArgumentException

Create a Input.MultiInput which reads from an archive 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 input.

Throws:

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

archive

public static Input.MultiInput archive(ArchiveFormat format,
                                       byte[] bytes)

Create a Input.MultiInput which reads from an array of bytes.

Parameters:

format - The format of the archive.

bytes - The bytes.

Returns:

The input.

archive

public static Input.MultiInput archive(ArchiveFormat format,
                                       java.io.InputStream stream)

Create a Input.MultiInput which reads from an existing stream.

Parameters:

format - The format of the archive.

stream - The path.

Returns:

The input.

folder

public static Input.MultiInput folder(java.nio.file.Path folder)

Create a Input.MultiInput which reads from a folder.

Parameters:

folder - The folder.

Returns:

The input.

open

public abstract void open(java.lang.String prefix)
                   throws java.io.IOException

Called to open any internal resources and set up the input for reading.

Parameters:

prefix - A prefix directory to read from.

Throws:

java.io.IOException

index

public abstract java.util.Set<java.lang.String> index()
                                               throws java.io.IOException

Get the index for this input.

Returns:

The index of this input.

Throws:

java.io.IOException

readLines

public java.util.List<java.lang.String> readLines(java.lang.String key)
                                           throws java.io.IOException

Read the given entry as a List of Strings.

Parameters:

key - The entry to read.

Returns:

The List of Strings for this entry.

Throws:

java.io.IOException

read

public byte[] read(java.lang.String key)
            throws java.io.IOException

Read the given entry as an array of bytes.

Parameters:

key - The entry to read.

Returns:

The bytes of the entry.

Throws:

java.io.IOException

tryRead

public abstract byte[] tryRead(java.lang.String key)
                        throws java.io.IOException

Try and read the given entry as an array of bytes.

Parameters:

key - The entry to read.

Returns:

The bytes of the entry, or null.

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