MapListFile (DBFlute Runtime 1.1.0-sp2-RC1 API)

java.lang.Object
- org.dbflute.helper.mapstring.MapListFile

```
public class MapListFile
extends Object
```
導入されたバージョン:

0.9.7.1 (2010/06/06 Sunday)

作成者:

jflute

フィールドのサマリー

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

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

コンストラクタ
コンストラクタと説明

MapListFile()

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

メソッドのサマリー

All Methods Instance Methods Concrete Methods
修飾子とタイプ	メソッドと説明
`MapListFile`	`checkDuplicateEntry()`
`protected MapListString`	`createMapListString()`
`protected String`	`getFileEncoding()`
`protected String`	`getLineCommentMark()`
`protected String`	`ln()`
`protected <KEY,VALUE> LinkedHashMap<KEY,VALUE>`	`newLinkedHashMap()`
`List<Object>`	`readList(InputStream ins)` Read the list string file.
`Map<String,Object>`	`readMap(InputStream ins)` Read the map string file.
`Map<String,List<String>>`	`readMapAsStringListValue(InputStream ins)` Read the map string file as string list value.
`Map<String,Map<String,String>>`	`readMapAsStringMapValue(InputStream ins)` Read the map string file as string map value.
`Map<String,String>`	`readMapAsStringValue(InputStream ins)` Read the map string file as string value.
`String`	`readString(InputStream ins)` Read the string file.
`protected String`	`removeInitialUnicodeBomIfNeeds(String encoding, String value)`
`MapListFile`	`skipLineSeparator()`
`void`	`writeList(OutputStream ous, List<Object> list)`
`void`	`writeMap(OutputStream ous, Map<String,? extends Object> map)`
`void`	`writeString(OutputStream ous, String mapListString)`

クラスから継承されたメソッド java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

フィールドの詳細

_fileEncoding
```
protected final String _fileEncoding
```

_lineCommentMark

protected final String _lineCommentMark

_skipLineSeparator
```
protected boolean _skipLineSeparator
```

_checkDuplicateEntry
```
protected boolean _checkDuplicateEntry
```

コンストラクタの詳細
- MapListFile
```
public MapListFile()
```

メソッドの詳細
- 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)
  
  例外:
  
  IOException - When it fails to handle the IO.
- readMapAsStringValue
```
public Map<String,String> readMapAsStringValue(InputStream ins)
                                        throws IOException
```
  Read the map string file as string value.
  If the type of all values is string type, this method is available.
  A trimmed line that starts with '#' is treated as line comment.
```
 e.g.
 map:{
     ; key1 = string-value1
     ; key2 = string-value2
     ; ... = ...
 }
 
```
  パラメータ:
  
  ins - The input stream for DBFlute property file, which is closed here. (NotNull)
  
  戻り値:
  
  The read map whose values is string. (NotNull)
  
  例外:
  
  IOException - When it fails to handle the IO.
- readMapAsStringListValue
```
public Map<String,List<String>> readMapAsStringListValue(InputStream ins)
                                                  throws IOException
```
  Read the map string file as string list value.
  If the type of all values is string list type, this method is available.
  A trimmed line that starts with '#' is treated as line comment.
```
 e.g.
 map:{
     ; key1 = list:{string-element1 ; string-element2 ; ...}
     ; key2 = list:{string-element1 ; string-element2 ; ...}
     ; ... = list:{...}
 }
 
```
  パラメータ:
  
  ins - The input stream for DBFlute property file, which is closed here. (NotNull)
  
  戻り値:
  
  The read map whose values is string list. (NotNull)
  
  例外:
  
  IOException - When it fails to handle the IO.
- readMapAsStringMapValue
```
public Map<String,Map<String,String>> readMapAsStringMapValue(InputStream ins)
                                                       throws IOException
```
  Read the map string file as string 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:{...}
 }
 
```
  パラメータ:
  
  ins - The input stream for DBFlute property file, which is closed here. (NotNull)
  
  戻り値:
  
  The read map whose values is string map. (NotNull)
  
  例外:
  
  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)
  
  例外:
  
  IOException - When it fails to handle the IO.
- writeList
```
public void writeList(OutputStream ous,
                      List<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 mapListString)
                 throws IOException
```
  例外:
  
  IOException
- skipLineSeparator
```
public MapListFile skipLineSeparator()
```
- checkDuplicateEntry
```
public MapListFile checkDuplicateEntry()
```
- createMapListString
```
protected MapListString createMapListString()
```
- removeInitialUnicodeBomIfNeeds
```
protected String removeInitialUnicodeBomIfNeeds(String encoding,
                                                String value)
```
- ln
```
protected String ln()
```
- newLinkedHashMap
```
protected <KEY,VALUE> LinkedHashMap<KEY,VALUE> newLinkedHashMap()
```
- getFileEncoding
```
protected String getFileEncoding()
```
- getLineCommentMark
```
protected String getLineCommentMark()
```

クラス MapListFile

フィールドのサマリー

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

メソッドのサマリー

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

フィールドの詳細

_fileEncoding

_lineCommentMark

_skipLineSeparator

_checkDuplicateEntry

コンストラクタの詳細

MapListFile

メソッドの詳細

readMap

readMapAsStringValue

readMapAsStringListValue

readMapAsStringMapValue

writeMap

readList

writeList

readString

writeString

skipLineSeparator

checkDuplicateEntry

createMapListString

removeInitialUnicodeBomIfNeeds

ln

newLinkedHashMap

getFileEncoding

getLineCommentMark