de.must.io

Class TextFile

java.lang.Object

de.must.io.TextFile

public class TextFile
extends java.lang.Object

Text file for input use.

 Sample:
     textFile = new TextFile("Xy.txt");
     String temp;
     while ((temp = textFile.readLine()) != null) {
       list.addItem(temp);
     }
 

See Also:

DataTextObject, DataTextObjectWithDelimiter

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ENCODING_ANSI
static java.lang.String	ENCODING_ASCII
static java.lang.String	ENCODING_UNICODE
static java.lang.String	ENCODING_UTF8
static int	OPENING_FROM_CLASS_LOADER
static int	OPENING_FROM_CURRENT_DIRECTORY
static java.lang.String	validChars

Constructor Summary

Constructors

Constructor and Description
TextFile(java.io.InputStreamReader isr)
TextFile(java.lang.String fileName) Constructs a new text file object and opens the file as specified searching in the path.
TextFile(java.lang.String fileName, int openingFrom) Constructs a new text file object and opens the file as specified searching as specified in openingForm.
TextFile(java.lang.String fileName, java.lang.String encoding) Constructs a new text file object and opens the file as specified searching in the path.
TextFile(java.lang.String fileName, java.lang.String encoding, int openingFrom) Constructs a new text file object and opens the file as specified searching as specified in openingForm.

Method Summary

Modifier and Type	Method and Description
void	close() Closes the text file.
void	delete() Delete the text file after closing it.
protected void	finalize()
java.lang.String	getFilePath() Returns the absolute file path of a file previously accessed by class loader.
java.lang.String	getLine() Return the line as previously read by nextLine().
java.lang.String	getOpenResultText() Returns the open result text which is "" if everything is OK.
boolean	isOpen() Returns true if the file is open.
boolean	lineContainsNonTextData() Returns true if line contains not-text-data.
boolean	nextLine() Reads the next line and buffers it to be fetched by getLine.
java.lang.String	readLine() Reads the next line and returns its value, which is null in EOF case.
void	StartFromBeginning() Causes the sequential read to restart from beginning.

Methods inherited from class java.lang.Object

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

Field Detail

validChars

public static final java.lang.String validChars

See Also:

Constant Field Values

ENCODING_ANSI

public static final java.lang.String ENCODING_ANSI

See Also:

Constant Field Values

ENCODING_ASCII

public static final java.lang.String ENCODING_ASCII

See Also:

Constant Field Values

ENCODING_UTF8

public static final java.lang.String ENCODING_UTF8

See Also:

Constant Field Values

ENCODING_UNICODE

public static final java.lang.String ENCODING_UNICODE

See Also:

Constant Field Values

OPENING_FROM_CURRENT_DIRECTORY

public static final int OPENING_FROM_CURRENT_DIRECTORY

See Also:

Constant Field Values

OPENING_FROM_CLASS_LOADER

public static final int OPENING_FROM_CLASS_LOADER

See Also:

Constant Field Values

Constructor Detail

TextFile

public TextFile(java.lang.String fileName)

Constructs a new text file object and opens the file as specified searching in the path.

Parameters:

fileName - the name of the file to use

TextFile

public TextFile(java.lang.String fileName,
                java.lang.String encoding)

Constructs a new text file object and opens the file as specified searching in the path.

Parameters:

fileName - the name of the file to use

encoding - the encoding type

See Also:

ENCODING_ASCII

TextFile

public TextFile(java.lang.String fileName,
                int openingFrom)

Constructs a new text file object and opens the file as specified searching as specified in openingForm.

Parameters:

fileName - the name of the file to use

openingFrom - the reference type from which directory the file to open is referenced

See Also:

ENCODING_ASCII

TextFile

public TextFile(java.lang.String fileName,
                java.lang.String encoding,
                int openingFrom)

Constructs a new text file object and opens the file as specified searching as specified in openingForm.

Parameters:

fileName - the name of the file to use

encoding - the encoding type

openingFrom - the reference type from which directory the file to open is referenced

See Also:

ENCODING_ASCII

TextFile

public TextFile(java.io.InputStreamReader isr)

Method Detail

isOpen

public boolean isOpen()

Returns true if the file is open.

Returns:

true if the file is open

getOpenResultText

public java.lang.String getOpenResultText()

Returns the open result text which is "" if everything is OK.

Returns:

the open result text

getFilePath

public java.lang.String getFilePath()

Returns the absolute file path of a file previously accessed by class loader. Workaround to multiple access of different files by the same name

Returns:

the absolute file path of a file previously accessed by class loader

StartFromBeginning

public void StartFromBeginning()

Causes the sequential read to restart from beginning.

nextLine

public boolean nextLine()

Reads the next line and buffers it to be fetched by getLine.

Returns:

true if a line was found

lineContainsNonTextData

public boolean lineContainsNonTextData()

Returns true if line contains not-text-data.

Returns:

true if line contains not-text-data

getLine

public java.lang.String getLine()

Return the line as previously read by nextLine().

Returns:

the line as previously read by nextLine

See Also:

nextLine()

readLine

public java.lang.String readLine()

Reads the next line and returns its value, which is null in EOF case.

Returns:

the next line of the file

close

public void close()

Closes the text file.

delete

public void delete()

Delete the text file after closing it.

finalize

protected void finalize()

Overrides:

finalize in class java.lang.Object