org.dbflute.helper.filesystem

クラス FileTextIO

java.lang.Object

org.dbflute.helper.filesystem.FileTextIO

public class FileTextIO
extends Object

The file handling class for text IO.

 FileTextIO textIO = new FileTextIO().encodeAsUTF8();
 textIO.read(...);
 

導入されたバージョン:

1.0.5K (2014/08/15 Friday)

作成者:

jflute

フィールドのサマリー

フィールド

修飾子とタイプ	フィールドと説明
protected String	_encoding The encoding for the file.
protected boolean	_removeUTF8Bom
protected boolean	_replaceCrLfToLf

コンストラクタのサマリー

コンストラクタ

コンストラクタと説明
FileTextIO()

メソッドのサマリー

修飾子とタイプ	メソッドと説明
protected String	adjustInOutTextIfNeeds(String text)
protected void	assertObjectNotNull(String variableName, Object value)
protected void	assertState()
protected void	assertStringNotNullAndNotTrimmedEmpty(String variableName, String value)
protected void	close(BufferedReader reader)
protected void	close(BufferedWriter writer)
protected FileInputStream	createFileInputStream(String textPath)
protected FileOutputStream	createFileOutputStream(String textPath)
protected String	doRemoveUTF8BomIfNeeds(String text)
protected String	doReplaceCrLfToLfIfNeeds(String text)
FileTextIO	encodeAsUTF8() Encode file as UTF-8.
FileTextIO	encodeAsWindows31J() Encode file as Windows-31J.
protected String	filterAsLine(String text, FileTextLineFilter filter)
protected String	filterAsWhole(String text, FileTextWholeFilter filter)
protected String	handleInputStreamReadFailureException(InputStream ins, IOException e)
protected void	handleOutputStreamWriteFailureException(OutputStream ous, IOException e)
protected String	handleTextFileReadFailureException(String textPath, IOException e)
protected void	handleTextFileWriteFailureException(String textPath, IOException e)
protected void	mkdirsIfNeeds(String textPath)
String	read(InputStream ins)
String	read(String textPath)
protected byte[]	readBytesClosed(InputStream ins)
String	readFilteringLine(InputStream ins, FileTextLineFilter oneArgLambda)
String	readFilteringLine(String textPath, FileTextLineFilter oneArgLambda)
String	readFilteringWhole(InputStream ins, FileTextWholeFilter oneArgLambda)
String	readFilteringWhole(String textPath, FileTextWholeFilter oneArgLambda)
protected String	readTextClosed(InputStream ins)
FileTextIO	removeUTF8Bom() Remove initial UTF-8 bom if it exists.
protected String	replace(String str, String fromStr, String toStr)
FileTextIO	replaceCrLfToLf() Replace CR+LF to LF when read and write.
String	rewriteFilteringLine(String textPath, FileTextLineFilter oneArgLambda)
String	rewriteFilteringLine(String textPath, FileTextWholeFilter oneArgLambda)
void	setEncoding(String encoding)
void	write(OutputStream ous, String text)
void	write(String textPath, String text)
String	writeFilteringLine(OutputStream ous, String text, FileTextLineFilter oneArgLambda)
String	writeFilteringLine(OutputStream ous, String text, FileTextWholeFilter oneArgLambda)
String	writeFilteringLine(String textPath, String text, FileTextLineFilter oneArgLambda)
String	writeFilteringLine(String textPath, String text, FileTextWholeFilter oneArgLambda)
protected void	writeTextClosed(OutputStream ous, String text)

クラスから継承されたメソッド java.lang.Object

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

フィールドの詳細

_encoding

protected String _encoding

The encoding for the file. (Required)

_removeUTF8Bom

protected boolean _removeUTF8Bom

_replaceCrLfToLf

protected boolean _replaceCrLfToLf

コンストラクタの詳細

FileTextIO

public FileTextIO()

メソッドの詳細

encodeAsUTF8

public FileTextIO encodeAsUTF8()

Encode file as UTF-8.

戻り値:

this. (NotNull)

encodeAsWindows31J

public FileTextIO encodeAsWindows31J()

Encode file as Windows-31J.

戻り値:

this. (NotNull)

removeUTF8Bom

public FileTextIO removeUTF8Bom()

Remove initial UTF-8 bom if it exists.

戻り値:

this. (NotNull)

replaceCrLfToLf

public FileTextIO replaceCrLfToLf()

Replace CR+LF to LF when read and write.

戻り値:

this. (NotNull)

read

public String read(InputStream ins)

パラメータ:

ins - The input stream for the text. (NotNull)

戻り値:

The read text. (NotNull)

read

public String read(String textPath)

パラメータ:

textPath - The path to the text file. (NotNull)

戻り値:

The read text. (NotNull)

readFilteringLine

public String readFilteringLine(String textPath,
                                FileTextLineFilter oneArgLambda)

パラメータ:

textPath - The path to the text file. (NotNull)

oneArgLambda - The filter of text line. (NotNull)

戻り値:

The filtered read text. (NotNull)

readFilteringLine

public String readFilteringLine(InputStream ins,
                                FileTextLineFilter oneArgLambda)

パラメータ:

ins - The input stream for the text. (NotNull)

oneArgLambda - The filter of text line. (NotNull)

戻り値:

The filtered read text. (NotNull)

readFilteringWhole

public String readFilteringWhole(String textPath,
                                 FileTextWholeFilter oneArgLambda)

パラメータ:

textPath - The path to the text file. (NotNull)

oneArgLambda - The filter of whole text. (NotNull)

戻り値:

The filtered read text. (NotNull)

readFilteringWhole

public String readFilteringWhole(InputStream ins,
                                 FileTextWholeFilter oneArgLambda)

パラメータ:

ins - The input stream for the text. (NotNull)

oneArgLambda - The filter of whole text. (NotNull)

戻り値:

The filtered read text. (NotNull)

rewriteFilteringLine

public String rewriteFilteringLine(String textPath,
                                   FileTextLineFilter oneArgLambda)

パラメータ:

textPath - The path to the text file. (NotNull)

oneArgLambda - The filter of text line. (NotNull)

戻り値:

The filtered written text. (NotNull)

rewriteFilteringLine

public String rewriteFilteringLine(String textPath,
                                   FileTextWholeFilter oneArgLambda)

パラメータ:

textPath - The path to the text file. (NotNull)

oneArgLambda - The filter of whole text. (NotNull)

戻り値:

The filtered written text. (NotNull)

write

public void write(OutputStream ous,
                  String text)

パラメータ:

ous - The output stream for the text. (NotNull)

text - The written text. (NotNull)

write

public void write(String textPath,
                  String text)

パラメータ:

textPath - The path to the text file. (NotNull)

text - The written text. (NotNull)

writeFilteringLine

public String writeFilteringLine(String textPath,
                                 String text,
                                 FileTextLineFilter oneArgLambda)

パラメータ:

textPath - The path to the text file. (NotNull)

text - The written text. (NotNull)

oneArgLambda - The filter of text line. (NotNull)

戻り値:

The filtered written text. (NotNull)

writeFilteringLine

public String writeFilteringLine(OutputStream ous,
                                 String text,
                                 FileTextLineFilter oneArgLambda)

パラメータ:

ous - The output stream for the text. (NotNull)

text - The written text. (NotNull)

oneArgLambda - The filter of text line. (NotNull)

戻り値:

The filtered written text. (NotNull)

writeFilteringLine

public String writeFilteringLine(String textPath,
                                 String text,
                                 FileTextWholeFilter oneArgLambda)

パラメータ:

textPath - The path to the text file. (NotNull)

text - The written text. (NotNull)

oneArgLambda - The filter of whole text. (NotNull)

戻り値:

The filtered written text. (NotNull)

writeFilteringLine

public String writeFilteringLine(OutputStream ous,
                                 String text,
                                 FileTextWholeFilter oneArgLambda)

パラメータ:

ous - The output stream for the text. (NotNull)

text - The written text. (NotNull)

oneArgLambda - The filter of whole text. (NotNull)

戻り値:

The filtered written text. (NotNull)

createFileInputStream

protected FileInputStream createFileInputStream(String textPath)

createFileOutputStream

protected FileOutputStream createFileOutputStream(String textPath)

mkdirsIfNeeds

protected void mkdirsIfNeeds(String textPath)

readBytesClosed

protected byte[] readBytesClosed(InputStream ins)
                          throws IOException

例外:

IOException

readTextClosed

protected String readTextClosed(InputStream ins)
                         throws IOException

例外:

IOException

writeTextClosed

protected void writeTextClosed(OutputStream ous,
                               String text)

adjustInOutTextIfNeeds

protected String adjustInOutTextIfNeeds(String text)

doRemoveUTF8BomIfNeeds

protected String doRemoveUTF8BomIfNeeds(String text)

doReplaceCrLfToLfIfNeeds

protected String doReplaceCrLfToLfIfNeeds(String text)

close

protected void close(BufferedReader reader)

close

protected void close(BufferedWriter writer)

handleOutputStreamWriteFailureException

protected void handleOutputStreamWriteFailureException(OutputStream ous,
                                                       IOException e)

handleTextFileWriteFailureException

protected void handleTextFileWriteFailureException(String textPath,
                                                   IOException e)

handleInputStreamReadFailureException

protected String handleInputStreamReadFailureException(InputStream ins,
                                                       IOException e)

handleTextFileReadFailureException

protected String handleTextFileReadFailureException(String textPath,
                                                    IOException e)

filterAsLine

protected String filterAsLine(String text,
                              FileTextLineFilter filter)

filterAsWhole

protected String filterAsWhole(String text,
                               FileTextWholeFilter filter)

assertState

protected void assertState()

assertObjectNotNull

protected void assertObjectNotNull(String variableName,
                                   Object value)

assertStringNotNullAndNotTrimmedEmpty

protected void assertStringNotNullAndNotTrimmedEmpty(String variableName,
                                                     String value)

replace

protected String replace(String str,
                         String fromStr,
                         String toStr)

setEncoding

public void setEncoding(String encoding)