codechicken.diffpatch.util

Class InputPath

java.lang.Object

codechicken.diffpatch.util.InputPath

Direct Known Subclasses:

InputPath.FilePath, InputPath.NullPath, InputPath.PipePath

public abstract class InputPath
extends java.lang.Object

Created by covers1624 on 25/8/20.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	InputPath.FilePath
static class	InputPath.NullPath
static class	InputPath.PipePath

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	InputPath(PathType type)

Method Summary

Modifier and Type	Method and Description
abstract boolean	exists() Gets if this input exists or not.
abstract ArchiveFormat	getFormat() Gets the ArchiveFormat of this input.
abstract java.lang.String	getName() Gets the name for this input.
PathType	getType() They type of Input this is.
abstract boolean	isFile() Gets if this input should be treated as a singular file, opposed to a folder.
abstract java.io.InputStream	open() Creates a stream representing this input.
abstract java.util.List<java.lang.String>	readAllLines() Reads all available lines of the input into a List of strings.
abstract java.nio.file.Path	toPath() Gets the underlying path representing this input.

Methods inherited from class java.lang.Object

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

Constructor Detail

InputPath

protected InputPath(PathType type)

Method Detail

getType

public PathType getType()

They type of Input this is.

Returns:

The type.

isFile

public abstract boolean isFile()

Gets if this input should be treated as a singular file, opposed to a folder.

Always true for PipePath inputs.

Returns:

If this input represents a singular file.

exists

public abstract boolean exists()

Gets if this input exists or not.

Returns:

If this input exists.

toPath

public abstract java.nio.file.Path toPath()

Gets the underlying path representing this input. Unsupported for PathType.PIPE

Returns:

The Path.

open

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

Creates a stream representing this input.

Returns:

The stream.

Throws:

java.io.IOException

readAllLines

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

Reads all available lines of the input into a List of strings.

Returns:

The Lines.

Throws:

java.io.IOException

getName

public abstract java.lang.String getName()

Gets the name for this input. Unsupported for PathType.PIPE

Returns:

The name.

getFormat

public abstract ArchiveFormat getFormat()

Gets the ArchiveFormat of this input. May be null indicating raw file or path.

Returns:

The format.