org.dbflute.helper.jprop

クラス ObjectiveProperties

java.lang.Object

org.dbflute.helper.jprop.ObjectiveProperties

public class ObjectiveProperties
extends Object

The properties object that can be objective.
You can make properties that extends other (super) properties.

導入されたバージョン:

1.0.1 (2012/12/30 Sunday)

作成者:

jflute

フィールドのサマリー

フィールド

修飾子とタイプ	フィールドと説明
protected boolean	_checkImplicitOverride Does it check the implicit override property?
protected List<String>	_extendsResourcePathList The list of resource path of extends properties loaded by class loader.
protected JavaPropertiesResult	_javaPropertiesResult The result of java properties reading.
protected String	_resourcePath The resource path of (base-point) properties loaded by class loader.
protected String	_streamEncoding The encoding for stream to the properties file.

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

コンストラクタ

コンストラクタと説明
ObjectiveProperties(String resourcePath)

メソッドのサマリー

修飾子とタイプ	メソッドと説明
ObjectiveProperties	checkImplicitOverride() Enable implicit override check.
protected JavaPropertiesReader	createJavaPropertiesReader(String title)
protected JavaPropertiesStreamProvider	createJavaPropertiesStreamProvider()
ObjectiveProperties	encodeAsUTF8() Encode the stream to the properties file as UTF-8.
boolean	equals(Object obj)
ObjectiveProperties	extendsProperties(String... extendsResourcePaths) Set the properties paths to extends them.
String	get(String propertyKey) Get the value of property as String.
Date	getAsDate(String propertyKey) Get the value of property as Date.
BigDecimal	getAsDecimal(String propertyKey) Get the value of property as BigDecimal.
Integer	getAsInteger(String propertyKey) Get the value of property as Integer.
Long	getAsLong(String propertyKey) Get the value of property as Long.
List<String>	getExtendsResourcePathList() Get the list of resource path of extends properties loaded by class loader.
JavaPropertiesResult	getJavaPropertiesResult() Get the result of java properties reading.
String	getResourcePath() Get the resource path of (base-point) properties loaded by class loader.
int	hashCode()
boolean	is(String propertyKey) Is the property true?
boolean	isCheckImplicitOverride() Does it check the implicit override property?
ObjectiveProperties	load() Load properties.
protected void	prepareExtendsProperties(JavaPropertiesReader reader)
protected InputStream	toStream(String resourcePath)
String	toString()
protected String	toTitle(String path)

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

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

フィールドの詳細

_resourcePath

protected final String _resourcePath

The resource path of (base-point) properties loaded by class loader. (NotNull)

_extendsResourcePathList

protected List<String> _extendsResourcePathList

The list of resource path of extends properties loaded by class loader. (NotNull, EmptyAllowed)

_checkImplicitOverride

protected boolean _checkImplicitOverride

Does it check the implicit override property?

_streamEncoding

protected String _streamEncoding

The encoding for stream to the properties file. (NullAllowed: if nul, use default encoding)

_javaPropertiesResult

protected JavaPropertiesResult _javaPropertiesResult

The result of java properties reading. (NotNull: after loading)

コンストラクタの詳細

ObjectiveProperties

public ObjectiveProperties(String resourcePath)

パラメータ:

resourcePath - The path of the property as resource for this class loader. (NotNull)

メソッドの詳細

extendsProperties

public ObjectiveProperties extendsProperties(String... extendsResourcePaths)

Set the properties paths to extends them.

パラメータ:

extendsResourcePaths - The varying array of path for resources to extends. (NotNull)

戻り値:

this. (NotNull)

checkImplicitOverride

public ObjectiveProperties checkImplicitOverride()

Enable implicit override check.
If the property existing in super-properties is set in sub-properties implicitly, an exception is thrown (you can detect the wrong situation). You can override by override annotation in the line comment like this:

 # @Override here is comment area, you can write about the property
 foo.bar = qux
 

And if the property with override annotation but no existence in super-properties, an exception is thrown (you can detect the wrong situation).

戻り値:

this. (NotNull)

encodeAsUTF8

public ObjectiveProperties encodeAsUTF8()

Encode the stream to the properties file as UTF-8.
If not use this, encoded as default encoding.

戻り値:

this. (NotNull)

load

public ObjectiveProperties load()

Load properties.
You can get properties after loading.

戻り値:

this. (NotNull)

createJavaPropertiesReader

protected JavaPropertiesReader createJavaPropertiesReader(String title)

createJavaPropertiesStreamProvider

protected JavaPropertiesStreamProvider createJavaPropertiesStreamProvider()

prepareExtendsProperties

protected void prepareExtendsProperties(JavaPropertiesReader reader)

toTitle

protected String toTitle(String path)

toStream

protected InputStream toStream(String resourcePath)

get

public String get(String propertyKey)

Get the value of property as String.

パラメータ:

propertyKey - The key of the property. (NotNull)

戻り値:

The value of found property. (NullAllowed: if null, not found)

getAsInteger

public Integer getAsInteger(String propertyKey)

Get the value of property as Integer.

パラメータ:

propertyKey - The key of the property. (NotNull)

戻り値:

The value of found property. (NullAllowed: if null, not found)

例外:

NumberFormatException - When the property is not integer.

getAsLong

public Long getAsLong(String propertyKey)

Get the value of property as Long.

パラメータ:

propertyKey - The key of the property. (NotNull)

戻り値:

The value of found property. (NullAllowed: if null, not found)

例外:

NumberFormatException - When the property is not long.

getAsDecimal

public BigDecimal getAsDecimal(String propertyKey)

Get the value of property as BigDecimal.

パラメータ:

propertyKey - The key of the property. (NotNull)

戻り値:

The value of found property. (NullAllowed: if null, not found)

例外:

NumberFormatException - When the property is not decimal.

getAsDate

public Date getAsDate(String propertyKey)

Get the value of property as Date.

パラメータ:

propertyKey - The key of the property. (NotNull)

戻り値:

The value of found property. (NullAllowed: if null, not found)

例外:

DfTypeUtil.ParseDateException - When it failed to parse the string to date.

DfTypeUtil.ParseDateNumberFormatException - When it failed to format the elements as number.

DfTypeUtil.ParseDateOutOfCalendarException - When the date was out of calendar. (if BC, not thrown)

is

public boolean is(String propertyKey)

Is the property true?

パラメータ:

propertyKey - The key of the property which is boolean type. (NotNull)

戻り値:

The determination, true or false. (if the property can be true, returns true)

equals

public boolean equals(Object obj)

オーバーライド:

equals クラス内 Object

hashCode

public int hashCode()

オーバーライド:

hashCode クラス内 Object

toString

public String toString()

オーバーライド:

toString クラス内 Object

getResourcePath

public String getResourcePath()

Get the resource path of (base-point) properties loaded by class loader. (NotNull)

戻り値:

The path string for the resource. (NotNull)

getExtendsResourcePathList

public List<String> getExtendsResourcePathList()

Get the list of resource path of extends properties loaded by class loader.

戻り値:

The list of path string for the resource. (NotNull, EmptyAllowed)

isCheckImplicitOverride

public boolean isCheckImplicitOverride()

Does it check the implicit override property?

戻り値:

The determination, true or false.

getJavaPropertiesResult

public JavaPropertiesResult getJavaPropertiesResult()

Get the result of java properties reading.

戻り値:

The result of java properties reading. (NotNull: after loading)