edu.hm.hafner.analysis

Class ReaderFactory

java.lang.Object

edu.hm.hafner.analysis.ReaderFactory

Direct Known Subclasses:

FileReaderFactory

public abstract class ReaderFactory
extends Object

Provides several useful helper methods to read the contents of a resource that is given by a Reader.

Author:

Ullrich Hafner

Constructor Summary

Constructors

Constructor and Description
ReaderFactory(Charset charset) Creates a new factory to read a resource with a given charset.
ReaderFactory(Charset charset, Function<String,String> lineMapper) Creates a new factory to read a resource with a given charset.

Method Summary

Modifier and Type	Method and Description
abstract Reader	create() Creates a new Reader for the file.
Charset	getCharset()
abstract String	getFileName() Returns the name of the resource.
Document	readDocument() Parses the whole file into a Document.
Stream<String>	readStream() Provides the lines of the file as a Stream of strings.
String	readString() Reads the whole file into a String.

Methods inherited from class java.lang.Object

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

Constructor Detail

ReaderFactory

public ReaderFactory(@CheckForNull
                     Charset charset)

Creates a new factory to read a resource with a given charset.

Parameters:

charset - the charset to use when reading the file

ReaderFactory

public ReaderFactory(@CheckForNull
                     Charset charset,
                     Function<String,String> lineMapper)

Creates a new factory to read a resource with a given charset.

Parameters:

charset - the charset to use when reading the file

lineMapper - provides a mapper to transform each of the resource lines

Method Detail

getFileName

public abstract String getFileName()

Returns the name of the resource.

Returns:

the file name

create

@MustBeClosed
public abstract Reader create()

Creates a new Reader for the file.

Returns:

a reader

readStream

@MustBeClosed
public Stream<String> readStream()

Provides the lines of the file as a Stream of strings.

Returns:

the file content as stream

Throws:

ParsingException - if the file could not be read

readString

public String readString()

Reads the whole file into a String.

Returns:

the file content as string

Throws:

ParsingException - if the file could not be read

readDocument

public Document readDocument()

Parses the whole file into a Document.

Returns:

the file content as document

Throws:

ParsingException - if the file could not be parsed

getCharset

public Charset getCharset()