org.unix4j.io

Class FileInput

java.lang.Object

org.unix4j.io.AbstractInput

org.unix4j.io.ReaderInput

org.unix4j.io.FileInput

All Implemented Interfaces:

java.lang.AutoCloseable, java.lang.Iterable<Line>, Input

public class FileInput
extends ReaderInput

Input device reading from a File.

Constructor Summary

Constructors

Constructor and Description
FileInput(java.io.File file)
FileInput(java.io.FileDescriptor fileDesc)
FileInput(java.io.File currentDirectory, java.io.File file)
FileInput(java.io.FileInputStream fileStream)
FileInput(java.io.FileReader fileReader)
FileInput(java.io.File currentDirectory, java.lang.String file)
FileInput(java.lang.String file)

Method Summary

Modifier and Type	Method and Description
static Input	composite(java.io.File... files) Creates and returns an input composed from the specified files altogether.
static Input	composite(java.util.List<java.io.File> files) Creates and returns an input composed from the specified files altogether.
java.lang.String	getFileInfo() Returns the file info string, for instance a file path or file name.
java.lang.String	getFileInfo(java.io.File relativeRoot) Returns the file info string relative to the given root directory.
static java.util.List<FileInput>	multiple(java.io.File... files) Creates a new FileInput object for each of the specified files and resturns a list with all input objects.
static java.util.List<FileInput>	multiple(java.util.List<java.io.File> files) Creates a new FileInput object for each of the specified files and resturns a list with all input objects.
java.lang.String	toString()

Methods inherited from class org.unix4j.io.ReaderInput

close, hasMoreLines, readLine

Methods inherited from class org.unix4j.io.AbstractInput

iterator

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

FileInput

public FileInput(java.io.FileReader fileReader)

FileInput

public FileInput(java.io.File currentDirectory,
                 java.io.File file)

FileInput

public FileInput(java.io.File file)

FileInput

public FileInput(java.io.FileInputStream fileStream)

FileInput

public FileInput(java.io.FileDescriptor fileDesc)

FileInput

public FileInput(java.lang.String file)

FileInput

public FileInput(java.io.File currentDirectory,
                 java.lang.String file)

Method Detail

multiple

public static java.util.List<FileInput> multiple(java.io.File... files)

Creates a new FileInput object for each of the specified files and resturns a list with all input objects.

Parameters:

files - the files for whose to create a FileInput object

multiple

public static java.util.List<FileInput> multiple(java.util.List<java.io.File> files)

Creates a new FileInput object for each of the specified files and resturns a list with all input objects.

Parameters:

files - the files for whose to create a FileInput object

composite

public static Input composite(java.io.File... files)

Creates and returns an input composed from the specified files altogether. The resulting input object returns the lines lines of the first file first, then the lines of the second file etc.

Parameters:

files - the files to combine into a single input object

composite

public static Input composite(java.util.List<java.io.File> files)

Creates and returns an input composed from the specified files altogether. The resulting input object returns the lines lines of the first file first, then the lines of the second file etc.

Parameters:

files - the files to combine into a single input object

getFileInfo

public java.lang.String getFileInfo()

Returns the file info string, for instance a file path or file name.

Returns:

the file info string, usually the file name or path.

getFileInfo

public java.lang.String getFileInfo(java.io.File relativeRoot)

Returns the file info string relative to the given root directory. If a relative path cannot be evaluated, the method defaults to getFileInfo().

Parameters:

relativeRoot - the relative root for the returned path, may be ignored if a relative path cannot be evaluated for the underlying source object

Returns:

the file info string, usually the file name or path relative to the given root directory

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object