org.dbflute.helper.dfmap

クラス DfMapFile

java.lang.Object

org.dbflute.helper.dfmap.DfMapFile

public class DfMapFile
extends Object

The parser of file as map style.

Detail Specification:

 o using DfMapStyle
 o file encoding is fixedly UTF-8
 o trimmed lines that start with '#' is treated as line comment
 o basically thread-safe if no changing option in progress
 

導入されたバージョン:

1.1.8 (2018/05/05 Saturday)

作成者:

jflute

フィールドのサマリー

フィールド

修飾子とタイプ	フィールドと説明
protected boolean	_checkDuplicateEntry
protected String	_fileEncoding
protected String	_lineCommentMark
protected boolean	_skipLineSeparator
static String	LINE_COMMENT_MARK
protected static String	UTF8_ENCODING

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

コンストラクタ

修飾子	コンストラクタと説明
	DfMapFile() Constructor for settings as default.
protected	DfMapFile(String fileEncoding, String lineCommentMark)

メソッドのサマリー

修飾子とタイプ	メソッドと説明
protected void	assertObjectNotNull(String variableName, Object value)
protected void	assertStringNotNullAndNotTrimmedEmpty(String variableName, String value)
DfMapFile	checkDuplicateEntry()
protected DfMapStyle	createMapStyle()
protected List<Object>	createResultList(DfMapStyle mapStyle)
protected Map<String,Object>	createResultMap(DfMapStyle mapStyle)
protected String	ln()
protected DfMapStyle	newMapStyle()
List<Object>	readList(InputStream ins) Read the list string file.
<ELEMENT> List<ELEMENT>	readList(InputStream ins, Class<ELEMENT> elementType) Read the list string file, as specified typed list element.
Map<String,Object>	readMap(InputStream ins) Read the map string file.
<VALUE> Map<String,VALUE>	readMap(InputStream ins, Class<VALUE> valueType) Read the map string file as specified typed map value.
String	readString(InputStream ins) Read the string file.
protected String	removeInitialUnicodeBomIfNeeds(String encoding, String value)
DfMapFile	skipLineSeparator()
void	writeList(OutputStream ous, List<? extends Object> list)
void	writeMap(OutputStream ous, Map<String,? extends Object> map)
void	writeString(OutputStream ous, String str)

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

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

フィールドの詳細

UTF8_ENCODING

protected static final String UTF8_ENCODING

関連項目:

定数フィールド値

LINE_COMMENT_MARK

public static final String LINE_COMMENT_MARK

関連項目:

定数フィールド値

_fileEncoding

protected final String _fileEncoding

_lineCommentMark

protected final String _lineCommentMark

_skipLineSeparator

protected boolean _skipLineSeparator

_checkDuplicateEntry

protected boolean _checkDuplicateEntry

コンストラクタの詳細

DfMapFile

public DfMapFile()

Constructor for settings as default.

DfMapFile

protected DfMapFile(String fileEncoding,
                    String lineCommentMark)

メソッドの詳細

skipLineSeparator

public DfMapFile skipLineSeparator()

checkDuplicateEntry

public DfMapFile checkDuplicateEntry()

readMap

public Map<String,Object> readMap(InputStream ins)
                           throws IOException

Read the map string file.
If the type of values is various type, this method is available.
A trimmed line that starts with '#' is treated as line comment.
This is the most basic method in the map-handling methods.

 map:{
     ; key1 = string-value1
     ; key2 = list:{element1 ; element2 }
     ; key3 = map:{key1 = value1 ; key2 = value2 }
     ; ... = ...
 }
 

パラメータ:

ins - The input stream for DBFlute property file, which is closed here. (NotNull)

戻り値:

The read map. (NotNull, EmptyAllowed)

例外:

IOException - When it fails to handle the IO.

readMap

public <VALUE> Map<String,VALUE> readMap(InputStream ins,
                                         Class<VALUE> valueType)
                                  throws IOException

Read the map string file as specified typed map value.
If the type of all values is string map type, this method is available.
A trimmed line that starts with '#' is treated as line comment.

 e.g.
 map:{
     ; key1 = map:{string-key1 = string-value1 ; string-key2 = string-value2 }
     ; key2 = map:{string-key1 = string-value1 ; string-key2 = string-value2 }
     ; ... = map:{...}
 }
 

型パラメータ:

VALUE - The type of value.

パラメータ:

ins - The input stream for DBFlute property file, which is closed here. (NotNull)

valueType - The type of value to cast. (NotNull)

戻り値:

The read map whose values are typed. (NotNull, EmptyAllowed)

例外:

IOException - When it fails to handle the IO.

writeMap

public void writeMap(OutputStream ous,
                     Map<String,? extends Object> map)
              throws IOException

例外:

IOException

readList

public List<Object> readList(InputStream ins)
                      throws IOException

Read the list string file.
If the type of values is various type, this method is available.
A trimmed line that starts with '#' is treated as line comment.

 list:{
     ; element1
     ; list:{element2-1 ; element2-2 }
     ; map:{key3-1 = value3-1 ; key3-2 = value3-2 }
     ; ...
 }
 

パラメータ:

ins - The input stream for DBFlute property file, which is closed here. (NotNull)

戻り値:

The read list. (NotNull, EmptyAllowed)

例外:

IOException - When it fails to handle the IO.

readList

public <ELEMENT> List<ELEMENT> readList(InputStream ins,
                                        Class<ELEMENT> elementType)
                                 throws IOException

Read the list string file, as specified typed list element.
If the type of values is various type, this method is available.
A trimmed line that starts with '#' is treated as line comment.

 list:{
     ; string-value1
     ; string-value1
     ; ...
 }
 

型パラメータ:

ELEMENT - The type of list element.

パラメータ:

ins - The input stream for DBFlute property file, which is closed here. (NotNull)

elementType - The type of list element to cast. (NotNull)

戻り値:

The read list whose elements are typed. (NotNull, EmptyAllowed)

例外:

IOException - When it fails to handle the IO.

writeList

public void writeList(OutputStream ous,
                      List<? extends Object> list)
               throws IOException

例外:

IOException

readString

public String readString(InputStream ins)
                  throws IOException

Read the string file.
A trimmed line that starts with '#' is treated as line comment.

パラメータ:

ins - The input stream for DBFlute property file. (NotNull)

戻り値:

The read string. (NotNull)

例外:

IOException - When it fails to handle the IO.

writeString

public void writeString(OutputStream ous,
                        String str)
                 throws IOException

例外:

IOException

createMapStyle

protected DfMapStyle createMapStyle()

newMapStyle

protected DfMapStyle newMapStyle()

createResultMap

protected Map<String,Object> createResultMap(DfMapStyle mapStyle)

createResultList

protected List<Object> createResultList(DfMapStyle mapStyle)

removeInitialUnicodeBomIfNeeds

protected String removeInitialUnicodeBomIfNeeds(String encoding,
                                                String value)

ln

protected String ln()

assertStringNotNullAndNotTrimmedEmpty

protected void assertStringNotNullAndNotTrimmedEmpty(String variableName,
                                                     String value)

assertObjectNotNull

protected void assertObjectNotNull(String variableName,
                                   Object value)