Module edu.hm.hafner.analysis.model

Package edu.hm.hafner.analysis

Class FileReaderFactory

java.lang.Object

edu.hm.hafner.analysis.ReaderFactory

edu.hm.hafner.analysis.FileReaderFactory

public class FileReaderFactory
extends ReaderFactory

Provides a ReaderFactory that returns readers for a given file.

Author:

Ullrich Hafner

Constructor Summary

Constructors

Constructor	Description
FileReaderFactory(Path file)	Creates a new factory to read the specified file.
FileReaderFactory(Path file, Charset charset)	Creates a new factory to read the specified file with a given charset.

Method Summary

Modifier and Type	Method	Description
Reader	create()	Creates a new Reader for the file.
Charset	getCharset()	Returns the character set that is used to read the stream.
String	getFileName()	Returns the absolute path of the resource.

Methods inherited from class edu.hm.hafner.analysis.ReaderFactory

parse, readDocument, readStream, readString

Methods inherited from class java.lang.Object

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

Constructor Details

FileReaderFactory

public FileReaderFactory(Path file,
 @CheckForNull
 Charset charset)

Creates a new factory to read the specified file with a given charset.

Parameters:

file - the file to open

charset - the charset to use when reading the file (or null if the charset should be detected)

FileReaderFactory

public FileReaderFactory(Path file)

Creates a new factory to read the specified file. The charset will be detected from xml header.

Parameters:

file - the file to open

Method Details

create

@MustBeClosed
public Reader create()

Description copied from class: ReaderFactory

Creates a new Reader for the file.

Specified by:

create in class ReaderFactory

Returns:

a reader

getFileName

public String getFileName()

Returns the absolute path of the resource. The file name uses UNIX path separators.

Specified by:

getFileName in class ReaderFactory

Returns:

the file name

getCharset

public Charset getCharset()

Description copied from class: ReaderFactory

Returns the character set that is used to read the stream.

Overrides:

getCharset in class ReaderFactory

Returns:

the character set