io.codechicken.diffpatch.util

Class Input.SingleInput

java.lang.Object

io.codechicken.diffpatch.util.Input

io.codechicken.diffpatch.util.Input.SingleInput

Direct Known Subclasses:

Input.SingleInput.FromPath, Input.SingleInput.FromStream, Input.SingleInput.FromString

Enclosing class:

Input

public abstract static class Input.SingleInput
extends Input

Represents an input with a single file source.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Input.SingleInput.FromPath
static class	Input.SingleInput.FromStream
static class	Input.SingleInput.FromString

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
SingleInput()

Method Summary

Modifier and Type	Method and Description
abstract java.lang.String	name()
abstract java.io.InputStream	open()
static Input.SingleInput	path(java.nio.file.Path path, java.nio.file.OpenOption... opts) A single file input.
static Input.SingleInput	pipe(java.io.InputStream is) Single file input for an existing InputStream, such as stdin.
static Input.SingleInput	pipe(java.io.InputStream is, java.lang.String name) Single file input for an existing InputStream, such as stdin.
java.util.List<java.lang.String>	readLines()
static Input.SingleInput	string(java.lang.String str) Single file input for an existing String.
static Input.SingleInput	string(java.lang.String str, java.lang.String name) Single file input for an existing InputStream, such as stdin.

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

SingleInput

public SingleInput()

Method Detail

string

public static Input.SingleInput string(java.lang.String str)

Single file input for an existing String.

This stream will have the name of 'pipe', diffing against this will produce this name in the +/- header lines.

Parameters:

str - The string.

Returns:

The input.

string

public static Input.SingleInput string(java.lang.String str,
                                       java.lang.String name)

Single file input for an existing InputStream, such as stdin.

Parameters:

str - The string.

name - The name of the stream. Used in +/- header lines of diffs.

Returns:

The input.

pipe

public static Input.SingleInput pipe(java.io.InputStream is)

Single file input for an existing InputStream, such as stdin.

This stream will have the name of 'pipe', diffing against this will produce this name in the +/- header lines.

Parameters:

is - The stream.

Returns:

The input.

pipe

public static Input.SingleInput pipe(java.io.InputStream is,
                                     java.lang.String name)

Single file input for an existing InputStream, such as stdin.

Parameters:

is - The stream.

name - The name of the stream. Used in +/- header lines of diffs.

Returns:

The input.

path

public static Input.SingleInput path(java.nio.file.Path path,
                                     java.nio.file.OpenOption... opts)

A single file input. for a Path.

Parameters:

path - The path.

opts - Any open options for the path.

Returns:

The input.

open

public abstract java.io.InputStream open()
                                  throws java.io.IOException

Throws:

java.io.IOException

readLines

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

Throws:

java.io.IOException

name

public abstract java.lang.String name()