org.dbflute.infra.dfprop

クラス DfPropFile

java.lang.Object

org.dbflute.infra.dfprop.DfPropFile

public class DfPropFile
extends Object

The file handling for DBFlute property (dfprop).

導入されたバージョン:

0.9.6 (2009/10/28 Wednesday)

作成者:

jflute

フィールドのサマリー

フィールド

修飾子とタイプ	フィールドと説明
protected boolean	_checkDuplicateEntry
protected boolean	_returnsNullIfNotFound
protected boolean	_skipLineSeparator

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

コンストラクタ

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

メソッドのサマリー

修飾子とタイプ	メソッドと説明
protected List<Object>	actuallyReadList(String path)
protected Map<String,Object>	actuallyReadMap(String path)
protected Map<String,List<String>>	actuallyReadMapAsStringListValue(String path)
protected Map<String,Map<String,String>>	actuallyReadMapAsStringMapValue(String path)
protected Map<String,String>	actuallyReadMapAsStringValue(String path)
protected String	actuallyReadString(String path)
protected void	assertDfpropPath(String dfpropPath)
protected <ELEMENT> List<ELEMENT>	callReadingListChecked(DfPropReadingListHandler<ELEMENT> handler, String path)
protected <ELEMENT> Map<String,ELEMENT>	callReadingMapChecked(DfPropReadingMapHandler<ELEMENT> handler, String path)
protected String	callReadingStringChecked(DfPropReadingStringHandler handler, String envPath)
DfPropFile	checkDuplicateEntry()
protected InputStream	createInputStream(String path)
protected MapListFile	createMapListFilePlain()
protected MapListFile	createMapListFileStructural()
protected String	deriveEnvPath(String dfpropPath, String envType)
protected String	deriveInheritPath(String path)
protected <ELEMENT> List<ELEMENT>	doReadList(String dfpropPath, String envType, DfPropReadingListHandler<ELEMENT> handler)
protected <ELEMENT> Map<String,ELEMENT>	doReadMap(String dfpropPath, String envType, DfPropReadingMapHandler<ELEMENT> handler)
protected String	doReadString(String dfpropPath, String envType, DfPropReadingStringHandler handler)
protected String	getInheritAllowedExt()
protected MapListFile	newMapListFile()
List<Object>	readList(String dfpropPath, String envType) Read the list string file.
Map<String,Object>	readMap(String dfpropPath, String envType) Read the map string file.
Map<String,List<String>>	readMapAsStringListValue(String dfpropPath, String envType) Read the map string file as string list value.
Map<String,Map<String,String>>	readMapAsStringMapValue(String dfpropPath, String envType) Read the map string file as string map value.
Map<String,String>	readMapAsStringValue(String dfpropPath, String envType) Read the map string file as string value.
String	readString(String dfpropPath, String envType) Read the string file.
protected <ELEMENT> boolean	resolveOutsidePropInheritMap(DfPropReadingMapHandler<ELEMENT> handler, String path, Map<String,ELEMENT> map)
DfPropFile	returnsNullIfNotFound()
DfPropFile	skipLineSeparator()
protected void	throwDfPropDuplicateEntryException(String path, MapListStringDuplicateEntryException e)
protected void	throwDfPropFileReadFailureException(String path, IOException e)

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

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

フィールドの詳細

_returnsNullIfNotFound

protected boolean _returnsNullIfNotFound

_skipLineSeparator

protected boolean _skipLineSeparator

_checkDuplicateEntry

protected boolean _checkDuplicateEntry

コンストラクタの詳細

DfPropFile

public DfPropFile()

メソッドの詳細

readMap

public Map<String,Object> readMap(String dfpropPath,
                                  String envType)

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 here.

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

And resolve property file, switched and extended file, for environment.
It returns merged properties like this:

 for example:
 
 [Switch Style]
 dbflute_exampledb
  |-dfprop
  |  |-maihama
  |  |  |-exampleMap.dfprop  // env
  |  |-exampleMap.dfprop     // main

 if maihama, env
 if default, main
 
 [Inherit Style]
 dbflute_exampledb
  |-dfprop
  |  |-maihama
  |  |  |-exampleMap+.dfprop // env+
  |  |-exampleMap.dfprop     // main
 
 if maihama, main and env+
 if default, main only
 
 [All Stars]
 dbflute_exampledb
  |-dfprop
  |  |-maihama
  |  |  |-exampleMap.dfprop  // env
  |  |  |-exampleMap+.dfprop // env+
  |  |-exampleMap.dfprop     // main
  |  |-exampleMap+.dfprop    // main+
 
 if maihama, env and env+
 if default, main and main+
 

パラメータ:

dfpropPath - The path of DBFlute property file. (NotNull)

envType - The environment type of DBFlute. (NullAllowed: if null, no environment file)

戻り値:

The read map. (NotNull: if not found, returns empty map)

actuallyReadMap

protected Map<String,Object> actuallyReadMap(String path)
                                      throws FileNotFoundException,
                                             IOException

例外:

FileNotFoundException

IOException

throwDfPropDuplicateEntryException

protected void throwDfPropDuplicateEntryException(String path,
                                                  MapListStringDuplicateEntryException e)

readMapAsStringValue

public Map<String,String> readMapAsStringValue(String dfpropPath,
                                               String envType)

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
     ; ... = ...
 }
 

And resolve property file for environment. (see the readMap(String, String))

パラメータ:

dfpropPath - The path of DBFlute property file. (NotNull)

envType - The environment type of DBFlute. (NullAllowed: if null, no environment file)

戻り値:

The read map whose values is string. (NotNull: if not found, returns empty map)

actuallyReadMapAsStringValue

protected Map<String,String> actuallyReadMapAsStringValue(String path)
                                                   throws FileNotFoundException,
                                                          IOException

例外:

FileNotFoundException

IOException

readMapAsStringListValue

public Map<String,List<String>> readMapAsStringListValue(String dfpropPath,
                                                         String envType)

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:{...}
 }
 

And resolve property file for environment. (see the readMap(String, String))

パラメータ:

dfpropPath - The path of DBFlute property file. (NotNull)

envType - The environment type of DBFlute. (NullAllowed: if null, no environment file)

戻り値:

The read map whose values is string list. (NotNull: if not found, returns empty map)

actuallyReadMapAsStringListValue

protected Map<String,List<String>> actuallyReadMapAsStringListValue(String path)
                                                             throws FileNotFoundException,
                                                                    IOException

例外:

FileNotFoundException

IOException

readMapAsStringMapValue

public Map<String,Map<String,String>> readMapAsStringMapValue(String dfpropPath,
                                                              String envType)

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:{...}
 }
 

And resolve property file for environment. (see the readMap(String, String))

パラメータ:

dfpropPath - The path of DBFlute property file. (NotNull)

envType - The environment type of DBFlute. (NullAllowed: if null, no environment file)

戻り値:

The read map whose values is string map. (NotNull: if not found, returns empty map)

actuallyReadMapAsStringMapValue

protected Map<String,Map<String,String>> actuallyReadMapAsStringMapValue(String path)
                                                                  throws FileNotFoundException,
                                                                         IOException

例外:

FileNotFoundException

IOException

readList

public List<Object> readList(String dfpropPath,
                             String envType)

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 }
     ; ... = ...
 }
 

パラメータ:

dfpropPath - The path of DBFlute property file. (NotNull)

envType - The environment type of DBFlute. (NullAllowed: if null, no environment file)

戻り値:

The read list of object. (NotNull: if not found, returns empty list)

actuallyReadList

protected List<Object> actuallyReadList(String path)
                                 throws FileNotFoundException,
                                        IOException

例外:

FileNotFoundException

IOException

readString

public String readString(String dfpropPath,
                         String envType)

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

パラメータ:

dfpropPath - The path of DBFlute property file. (NotNull)

envType - The environment type of DBFlute. (NullAllowed: if null, no environment file)

戻り値:

The read string. (NotNull: if not found, returns empty string)

actuallyReadString

protected String actuallyReadString(String path)
                             throws FileNotFoundException,
                                    IOException

例外:

FileNotFoundException

IOException

doReadMap

protected <ELEMENT> Map<String,ELEMENT> doReadMap(String dfpropPath,
                                                  String envType,
                                                  DfPropReadingMapHandler<ELEMENT> handler)

callReadingMapChecked

protected <ELEMENT> Map<String,ELEMENT> callReadingMapChecked(DfPropReadingMapHandler<ELEMENT> handler,
                                                              String path)

resolveOutsidePropInheritMap

protected <ELEMENT> boolean resolveOutsidePropInheritMap(DfPropReadingMapHandler<ELEMENT> handler,
                                                         String path,
                                                         Map<String,ELEMENT> map)

doReadList

protected <ELEMENT> List<ELEMENT> doReadList(String dfpropPath,
                                             String envType,
                                             DfPropReadingListHandler<ELEMENT> handler)

callReadingListChecked

protected <ELEMENT> List<ELEMENT> callReadingListChecked(DfPropReadingListHandler<ELEMENT> handler,
                                                         String path)

doReadString

protected String doReadString(String dfpropPath,
                              String envType,
                              DfPropReadingStringHandler handler)

callReadingStringChecked

protected String callReadingStringChecked(DfPropReadingStringHandler handler,
                                          String envPath)

deriveEnvPath

protected String deriveEnvPath(String dfpropPath,
                               String envType)

deriveInheritPath

protected String deriveInheritPath(String path)

getInheritAllowedExt

protected String getInheritAllowedExt()

createInputStream

protected InputStream createInputStream(String path)
                                 throws FileNotFoundException

例外:

FileNotFoundException

throwDfPropFileReadFailureException

protected void throwDfPropFileReadFailureException(String path,
                                                   IOException e)

createMapListFilePlain

protected MapListFile createMapListFilePlain()

createMapListFileStructural

protected MapListFile createMapListFileStructural()

newMapListFile

protected MapListFile newMapListFile()

assertDfpropPath

protected void assertDfpropPath(String dfpropPath)

returnsNullIfNotFound

public DfPropFile returnsNullIfNotFound()

skipLineSeparator

public DfPropFile skipLineSeparator()

checkDuplicateEntry

public DfPropFile checkDuplicateEntry()