MapListString (DBFlute Runtime 1.1.0-sp2-RC1 API)

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

public class MapListString
extends Object

The string for map and list.

 e.g. map-string
   map:{key1=value1,key2=list:{value21,value22,value23},key3=map:{key31=value31}}
 
 e.g. list-string
   list:{key1=value1,key2=list:{value21,value22,value23},key3=map:{key31=value31}}

作成者:: jflute

フィールドのサマリー

フィールド
修飾子とタイプ	フィールドと説明
`protected boolean`	`_checkDuplicateEntry` Does it check duplicate entry of map?
`protected String`	`_delimiter` The control mark of delimiter.
`protected String`	`_endBrace` The control mark of end brace.
`protected String`	`_equal` The control mark of equal for map-string.
`protected String`	`_escapeChar` The escape character for control marks.
`protected String`	`_listMark` The mark of list.
`protected String`	`_mapMark` The mark of map.
`protected String`	`_remainderString` The string of remainder as temporary variable for generation.
`protected String`	`_startBrace` The control mark of start brace.
`protected String`	`_topString` The string of top (full) string as temporary variable for generation.
`static String`	`DEFAULT_DELIMITER` The default control mark of delimiter.
`static String`	`DEFAULT_END_BRACE` The default control mark of end-brace.
`static String`	`DEFAULT_EQUAL` The default control mark of equal.
`static String`	`DEFAULT_LIST_MARK` The default mark of list value.
`static String`	`DEFAULT_MAP_MARK` The default mark of map value.
`static String`	`DEFAULT_START_BRACE` The default control mark of start-brace.
`protected static String`	`ESCAPE_CHAR` The escape character for control marks.
`protected static String`	`ESCAPED_ESCAPE_MARK` The temporary mark of escaped escape character.

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

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

MapListString()
Constructor setting as default.

コンストラクタ
コンストラクタと説明
`MapListString()` Constructor setting as default.

メソッドのサマリー

All Methods Instance Methods Concrete Methods
修飾子とタイプ	メソッドと説明
`protected void`	`assertListString(String listString)`
`protected void`	`assertListStringEndBraceIndex(String remainderString, int endBraceIndex, String listString, List<?> currentList)`
`protected void`	`assertMapString(String mapString)`
`protected void`	`assertMapStringEndBraceIndex(String remainderString, int endBraceIndex, String mapString, Map<String,Object> currentMap)`
`protected void`	`assertMapStringEqualIndex(String remainderString, int equalIndex, String mapString, Map<String,Object> currentMap)`
`protected String`	`buildLengthSpace(String value)`
`String`	`buildListString(List<? extends Object> list)` Build list-string from the list object.
`String`	`buildMapString(Map<String,? extends Object> map)` Build map-string from the map object.
`protected String`	`calculateNextIndent(String preIndent, String curIndent)`
`MapListString`	`checkDuplicateEntry()` Check duplicate entry of map.
`protected boolean`	`closeAfterParseNestMapList()` Close after parse nest map list.
`protected void`	`closeByEndBraceIndex(int endBraceIndex)` Close by end-brace index.
`protected void`	`doBuildListString(StringBuilder sb, List<? extends Object> list, String preIndent, String curIndent)`
`protected void`	`doBuildMapString(StringBuilder sb, Map<String,Object> map, String preIndent, String curIndent)`
`protected void`	`doCheckDuplicateEntryIfNeeds(Map<String,Object> currentMap, String key, Object element)`
`String`	`escapeControlMark(Object value)` Escape control marks as plain string in the value.
`protected String`	`filterMapListKey(String value)`
`protected String`	`filterMapListValue(String value)`
`protected int`	`findIndexOfControlMark(String remainderString, String controlMark)`
`List<Object>`	`generateList(String listString)` Generate map object from list-string.
`Map<String,Object>`	`generateMap(String mapString)` Generate map object from the map-string.
`protected int`	`getControlMarkCount(String targetString, String controlMark)`
`protected String`	`getListPrefix()`
`protected String`	`getMapPrefix()`
`protected int`	`indexOfDelimiter()`
`protected int`	`indexOfEndBrace()`
`protected int`	`indexOfEqual()`
`protected int`	`indexOfStartBrace()`
`protected boolean`	`initializeAtLoopBeginning()` Initialize at loop beginning.
`boolean`	`isCheckDuplicateEntry()`
`protected boolean`	`isEndsWithEndBrace(String targetString)` Does it end with end-brace?
`protected boolean`	`isEscapeCharEscape()`
`protected boolean`	`isStartsWithDelimiter(String targetString)` Does it start with the delimiter?
`protected boolean`	`isStartsWithEndBrace(String targetString)` Does it start with end-brace?
`protected boolean`	`isStartsWithListPrefix(String targetString)` Does it start with the list-prefix?
`protected boolean`	`isStartsWithMapPrefix(String targetString)` Does it start with the map-prefix?
`protected String`	`ln()`
`protected String`	`lnd()`
`protected List<Object>`	`newObjectList()` New object-type list.
`protected Map<String,Object>`	`newStringObjectMap()` New string-object map.
`protected void`	`parseRemainderListString(List<Object> currentList)` Parse remainder list string.
`protected void`	`parseRemainderMapString(Map<String,Object> currentMap)` Parse the current remainder string as map.
`protected void`	`prepareControlMarkMessage(ExceptionMessageBuilder br)`
`protected void`	`registerToMap(Map<String,Object> currentMap, String key, Object element)`
`protected void`	`removeBothSideSpaceAndTabAndNewLine()` Remove both side space and tab and new-line.
`protected void`	`removePrefix(String prefixString)` Remove prefix as mark.
`protected void`	`removePrefixAllDelimiter()` Remove prefix and all delimiters.
`protected void`	`removePrefixDelimiter()` Remove prefix delimiter.
`protected void`	`removePrefixEndBrace()` Remove prefix end-brace.
`protected void`	`removePrefixListMarkAndStartBrace()` Remove prefix list-mark and start-brace.
`protected void`	`removePrefixMapMarkAndStartBrace()` Remove prefix map-mark and start-brace.
`protected void`	`removePrefixTargetIndexPlus(int index, int plusCount)` Remove prefix by the index and plus count.
`protected String`	`replace(String str, String fromStr, String toStr)`
`void`	`setDelimiter(String delimiter)`
`void`	`setEndBrace(String endBrace)`
`void`	`setEqual(String equal)`
`void`	`setListMark(String listMark)`
`void`	`setMapMark(String mapMark)`
`void`	`setStartBrace(String startBrace)`
`protected List<Object>`	`setupNestList(List<Object> currentList)` Set up new-created nest list as element of the current list.
`protected List<Object>`	`setupNestList(Map<String,Object> currentMap, String mapKey)` Set up new-created nest list as element of the current map.
`protected Map<String,Object>`	`setupNestMap(List<Object> currentList)` Set up new-created nest map as element of the current list.
`protected Map<String,Object>`	`setupNestMap(Map<String,Object> currentMap, String mapKey)` Set up new-created nest map as element of the current map.
`protected void`	`throwListStringBasicFailureException(String notice, String listString)`
`protected void`	`throwListStringDifferentCountBracesException(String listString, int startCount, int endCount)`
`protected void`	`throwListStringEndBraceFailureException(String notice, String remainderMapString, int equalIndex, String listString, List<?> currentList)`
`protected void`	`throwListStringUnneededStringFoundException(String listString, List<Object> generatedList)`
`protected void`	`throwMapListStringPrefixFailureException(String notice, String prefixString, String mapString)`
`protected void`	`throwMapStringBasicFailureException(String notice, String mapString)`
`protected void`	`throwMapStringDifferentCountBracesException(String mapString, int startCount, int endCount)`
`protected void`	`throwMapStringDuplicateEntryFoundException(Map<String,Object> currentMap, String key, Object element)`
`protected void`	`throwMapStringEndBraceFailureException(String notice, String remainderMapString, int equalIndex, String mapString, Map<String,Object> currentMap)`
`protected void`	`throwMapStringEqualFailureException(String notice, String remainderMapString, int equalIndex, String mapString, Map<String,Object> currentMap)`
`protected void`	`throwMapStringUnneededStringFoundException(String mapString, Map<String,Object> generatedMap)`
`protected String`	`toEscapedMark(String mark)`
`String`	`unescapeControlMark(String value)` Un-escape control marks as plain string in the value.

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

フィールドの詳細
- DEFAULT_MAP_MARK
```
public static final String DEFAULT_MAP_MARK
```
  The default mark of map value.
  
  関連項目:
  
  定数フィールド値
- DEFAULT_LIST_MARK
```
public static final String DEFAULT_LIST_MARK
```
  The default mark of list value.
  
  関連項目:
  
  定数フィールド値
- DEFAULT_START_BRACE
```
public static final String DEFAULT_START_BRACE
```
  The default control mark of start-brace.
  
  関連項目:
  
  定数フィールド値
- DEFAULT_END_BRACE
```
public static final String DEFAULT_END_BRACE
```
  The default control mark of end-brace.
  
  関連項目:
  
  定数フィールド値
- DEFAULT_DELIMITER
```
public static final String DEFAULT_DELIMITER
```
  The default control mark of delimiter.
  
  関連項目:
  
  定数フィールド値
- DEFAULT_EQUAL
```
public static final String DEFAULT_EQUAL
```
  The default control mark of equal.
  
  関連項目:
  
  定数フィールド値
- ESCAPE_CHAR
```
protected static final String ESCAPE_CHAR
```
  The escape character for control marks.
  
  関連項目:
  
  定数フィールド値
- ESCAPED_ESCAPE_MARK
```
protected static final String ESCAPED_ESCAPE_MARK
```
  The temporary mark of escaped escape character.
  
  関連項目:
  
  定数フィールド値
- _mapMark
```
protected String _mapMark
```
  The mark of map. (NotNull: but changeable)
- _listMark
```
protected String _listMark
```
  The mark of list. (NotNull: but changeable)
- _startBrace
```
protected String _startBrace
```
  The control mark of start brace. (NotNull: but changeable)
- _endBrace
```
protected String _endBrace
```
  The control mark of end brace. (NotNull: but changeable)
- _delimiter
```
protected String _delimiter
```
  The control mark of delimiter. (NotNull: but changeable)
- _equal
```
protected String _equal
```
  The control mark of equal for map-string. (NotNull: but changeable)
- _escapeChar
```
protected final String _escapeChar
```
  The escape character for control marks. (NotNull)
- _topString
```
protected String _topString
```
  The string of top (full) string as temporary variable for generation. (NullAllowed: depends on process)
- _remainderString
```
protected String _remainderString
```
  The string of remainder as temporary variable for generation. (NullAllowed: depends on process)
- _checkDuplicateEntry
```
protected boolean _checkDuplicateEntry
```
  Does it check duplicate entry of map?

コンストラクタの詳細
- MapListString
```
public MapListString()
```
  Constructor setting as default.
  You can change marks by setters after creation.

メソッドの詳細

buildMapString
```
public String buildMapString(Map<String,? extends Object> map)
```
Build map-string from the map object.

パラメータ:

map - The map object that has string keys. (NotNull)

戻り値:

The string as map expression. (NotNull)

doBuildMapString

protected void doBuildMapString(StringBuilder sb,
                                Map<String,Object> map,
                                String preIndent,
                                String curIndent)

buildListString
```
public String buildListString(List<? extends Object> list)
```
Build list-string from the list object.

パラメータ:

list - The list object that has object elements. (NotNull)

戻り値:

The string as list expression. (NotNull)

doBuildListString

protected void doBuildListString(StringBuilder sb,
                                 List<? extends Object> list,
                                 String preIndent,
                                 String curIndent)

calculateNextIndent

protected String calculateNextIndent(String preIndent,
                                     String curIndent)

generateMap
```
public Map<String,Object> generateMap(String mapString)
```
Generate map object from the map-string.

パラメータ:

mapString - The string as map expression. (NotNull)

戻り値:

The generated map. (NotNull)

throwMapStringUnneededStringFoundException

protected void throwMapStringUnneededStringFoundException(String mapString,
                                                          Map<String,Object> generatedMap)

generateList
```
public List<Object> generateList(String listString)
```
Generate map object from list-string.

パラメータ:

listString - The string as list expression. (NotNull)

戻り値:

The generated list. (NotNull)

throwListStringUnneededStringFoundException

protected void throwListStringUnneededStringFoundException(String listString,
                                                           List<Object> generatedList)

parseRemainderMapString
```
protected void parseRemainderMapString(Map<String,Object> currentMap)
```
Parse the current remainder string as map.

パラメータ:

currentMap - The current map made by parse process. (NotNull)

parseRemainderListString
```
protected void parseRemainderListString(List<Object> currentList)
```
Parse remainder list string.

パラメータ:

currentList - current list.

initializeAtLoopBeginning
```
protected boolean initializeAtLoopBeginning()
```
Initialize at loop beginning.

戻り値:

Is is end?

closeAfterParseNestMapList
```
protected boolean closeAfterParseNestMapList()
```
Close after parse nest map list.

戻り値:

Is is closed?

closeByEndBraceIndex
```
protected void closeByEndBraceIndex(int endBraceIndex)
```
Close by end-brace index.

パラメータ:

endBraceIndex - The index of end-brace. (NotMinus)

indexOfStartBrace
```
protected int indexOfStartBrace()
```

indexOfEndBrace
```
protected int indexOfEndBrace()
```

indexOfDelimiter
```
protected int indexOfDelimiter()
```

indexOfEqual
```
protected int indexOfEqual()
```

findIndexOfControlMark

protected int findIndexOfControlMark(String remainderString,
                                     String controlMark)

buildLengthSpace

protected String buildLengthSpace(String value)

removePrefixMapMarkAndStartBrace
```
protected void removePrefixMapMarkAndStartBrace()
```
Remove prefix map-mark and start-brace.

removePrefixListMarkAndStartBrace
```
protected void removePrefixListMarkAndStartBrace()
```
Remove prefix list-mark and start-brace.

removePrefixDelimiter
```
protected void removePrefixDelimiter()
```
Remove prefix delimiter.

removePrefixEndBrace
```
protected void removePrefixEndBrace()
```
Remove prefix end-brace.

removePrefix
```
protected void removePrefix(String prefixString)
```
Remove prefix as mark.

パラメータ:

prefixString - The string for prefix. (NotNull)

throwMapListStringPrefixFailureException

protected void throwMapListStringPrefixFailureException(String notice,
                                                        String prefixString,
                                                        String mapString)

removePrefixAllDelimiter
```
protected void removePrefixAllDelimiter()
```
Remove prefix and all delimiters.

removeBothSideSpaceAndTabAndNewLine
```
protected void removeBothSideSpaceAndTabAndNewLine()
```
Remove both side space and tab and new-line.

removePrefixTargetIndexPlus
```
protected void removePrefixTargetIndexPlus(int index,
                                           int plusCount)
```
Remove prefix by the index and plus count.

パラメータ:

index - The base index. (NotMinus)

plusCount - The plus count for index. (NotMinus)

filterMapListKey

protected String filterMapListKey(String value)

filterMapListValue

protected String filterMapListValue(String value)

isStartsWithMapPrefix
```
protected boolean isStartsWithMapPrefix(String targetString)
```
Does it start with the map-prefix?

パラメータ:

targetString - The target string to determine. (NotNull)

戻り値:

The determination, true or false.

getMapPrefix
```
protected String getMapPrefix()
```

isStartsWithListPrefix
```
protected boolean isStartsWithListPrefix(String targetString)
```
Does it start with the list-prefix?

パラメータ:

targetString - The target-string to determine. (NotNull)

戻り値:

The determination, true or false.

getListPrefix
```
protected String getListPrefix()
```

isStartsWithDelimiter
```
protected boolean isStartsWithDelimiter(String targetString)
```
Does it start with the delimiter?

パラメータ:

targetString - The target string to determine. (NotNull)

戻り値:

The determination, true or false.

isStartsWithEndBrace
```
protected boolean isStartsWithEndBrace(String targetString)
```
Does it start with end-brace?

パラメータ:

targetString - The target string to determine. (NotNull)

戻り値:

The determination, true or false.

isEndsWithEndBrace
```
protected boolean isEndsWithEndBrace(String targetString)
```
Does it end with end-brace?

パラメータ:

targetString - The target string to determine. (NotNull)

戻り値:

The determination, true or false.

setupNestMap
```
protected Map<String,Object> setupNestMap(Map<String,Object> currentMap,
                                          String mapKey)
```
Set up new-created nest map as element of the current map.

パラメータ:

currentMap - the current map to set up. (NotNull)

mapKey - The key of nest map. (NotNull)

戻り値:

The new-created nest map. (NotNull)

setupNestMap
```
protected Map<String,Object> setupNestMap(List<Object> currentList)
```
Set up new-created nest map as element of the current list.

パラメータ:

currentList - the current list to set up. (NotNull)

戻り値:

The new-created nest map. (NotNull)

setupNestList
```
protected List<Object> setupNestList(Map<String,Object> currentMap,
                                     String mapKey)
```
Set up new-created nest list as element of the current map.

パラメータ:

currentMap - the current map to set up. (NotNull)

mapKey - The key of nest map. (NotNull)

戻り値:

The new-created nest list. (NotNull)

setupNestList
```
protected List<Object> setupNestList(List<Object> currentList)
```
Set up new-created nest list as element of the current list.

パラメータ:

currentList - the current map to set up. (NotNull)

戻り値:

The new-created nest list. (NotNull)

newStringObjectMap
```
protected Map<String,Object> newStringObjectMap()
```
New string-object map.

戻り値:

The new-created map. (NotNull)

newObjectList
```
protected List<Object> newObjectList()
```
New object-type list.

戻り値:

The new-created list. (NotNull)

registerToMap

protected void registerToMap(Map<String,Object> currentMap,
                             String key,
                             Object element)

doCheckDuplicateEntryIfNeeds

protected void doCheckDuplicateEntryIfNeeds(Map<String,Object> currentMap,
                                            String key,
                                            Object element)

throwMapStringDuplicateEntryFoundException

protected void throwMapStringDuplicateEntryFoundException(Map<String,Object> currentMap,
                                                          String key,
                                                          Object element)

escapeControlMark
```
public String escapeControlMark(Object value)
```
Escape control marks as plain string in the value.

パラメータ:

value - The value, might contain control marks. (NullAllowed: if null, return null)

戻り値:

The escaped string of the value. (NullAllowed: when the value is null)

unescapeControlMark
```
public String unescapeControlMark(String value)
```
Un-escape control marks as plain string in the value.

パラメータ:

value - The value, might contain escaped control marks. (NullAllowed: if null, return null)

戻り値:

The un-escaped string of the value. (NullAllowed: when the value is null)

toEscapedMark

protected String toEscapedMark(String mark)

isEscapeCharEscape

protected boolean isEscapeCharEscape()

assertMapString

protected void assertMapString(String mapString)

throwMapStringBasicFailureException

protected void throwMapStringBasicFailureException(String notice,
                                                   String mapString)

throwMapStringDifferentCountBracesException

protected void throwMapStringDifferentCountBracesException(String mapString,
                                                           int startCount,
                                                           int endCount)

assertListString

protected void assertListString(String listString)

throwListStringBasicFailureException

protected void throwListStringBasicFailureException(String notice,
                                                    String listString)

throwListStringDifferentCountBracesException

protected void throwListStringDifferentCountBracesException(String listString,
                                                            int startCount,
                                                            int endCount)

getControlMarkCount

protected int getControlMarkCount(String targetString,
                                  String controlMark)

assertMapStringEqualIndex

protected void assertMapStringEqualIndex(String remainderString,
                                         int equalIndex,
                                         String mapString,
                                         Map<String,Object> currentMap)

throwMapStringEqualFailureException

protected void throwMapStringEqualFailureException(String notice,
                                                   String remainderMapString,
                                                   int equalIndex,
                                                   String mapString,
                                                   Map<String,Object> currentMap)

assertMapStringEndBraceIndex

protected void assertMapStringEndBraceIndex(String remainderString,
                                            int endBraceIndex,
                                            String mapString,
                                            Map<String,Object> currentMap)

assertListStringEndBraceIndex

protected void assertListStringEndBraceIndex(String remainderString,
                                             int endBraceIndex,
                                             String listString,
                                             List<?> currentList)

throwMapStringEndBraceFailureException

protected void throwMapStringEndBraceFailureException(String notice,
                                                      String remainderMapString,
                                                      int equalIndex,
                                                      String mapString,
                                                      Map<String,Object> currentMap)

throwListStringEndBraceFailureException

protected void throwListStringEndBraceFailureException(String notice,
                                                       String remainderMapString,
                                                       int equalIndex,
                                                       String listString,
                                                       List<?> currentList)

prepareControlMarkMessage

protected void prepareControlMarkMessage(ExceptionMessageBuilder br)

replace

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

lnd
```
protected String lnd()
```

ln
```
protected String ln()
```

setMapMark

public void setMapMark(String mapMark)

setListMark

public void setListMark(String listMark)

setStartBrace

public void setStartBrace(String startBrace)

setEndBrace

public void setEndBrace(String endBrace)

setDelimiter

public void setDelimiter(String delimiter)

setEqual
```
public void setEqual(String equal)
```

checkDuplicateEntry
```
public MapListString checkDuplicateEntry()
```
Check duplicate entry of map. (throws exception if found)

戻り値:

this;

isCheckDuplicateEntry

public boolean isCheckDuplicateEntry()

クラス MapListString

フィールドのサマリー

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

メソッドのサマリー

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

フィールドの詳細

DEFAULT_MAP_MARK

DEFAULT_LIST_MARK

DEFAULT_START_BRACE

DEFAULT_END_BRACE

DEFAULT_DELIMITER

DEFAULT_EQUAL

ESCAPE_CHAR

ESCAPED_ESCAPE_MARK

_mapMark

_listMark

_startBrace

_endBrace

_delimiter

_equal

_escapeChar

_topString

_remainderString

_checkDuplicateEntry

コンストラクタの詳細

MapListString

メソッドの詳細

buildMapString

doBuildMapString

buildListString

doBuildListString

calculateNextIndent

generateMap

throwMapStringUnneededStringFoundException

generateList

throwListStringUnneededStringFoundException

parseRemainderMapString

parseRemainderListString

initializeAtLoopBeginning

closeAfterParseNestMapList

closeByEndBraceIndex

indexOfStartBrace

indexOfEndBrace

indexOfDelimiter

indexOfEqual

findIndexOfControlMark

buildLengthSpace

removePrefixMapMarkAndStartBrace

removePrefixListMarkAndStartBrace

removePrefixDelimiter

removePrefixEndBrace

removePrefix

throwMapListStringPrefixFailureException

removePrefixAllDelimiter

removeBothSideSpaceAndTabAndNewLine

removePrefixTargetIndexPlus

filterMapListKey

filterMapListValue

isStartsWithMapPrefix

getMapPrefix

isStartsWithListPrefix

getListPrefix

isStartsWithDelimiter

isStartsWithEndBrace

isEndsWithEndBrace

setupNestMap

setupNestMap

setupNestList

setupNestList

newStringObjectMap

newObjectList

registerToMap

doCheckDuplicateEntryIfNeeds

throwMapStringDuplicateEntryFoundException

escapeControlMark

unescapeControlMark

toEscapedMark

isEscapeCharEscape

assertMapString

throwMapStringBasicFailureException