クラス AbstractPropertyResolver
java.lang.ObjectSE
org.springframework.core.env.AbstractPropertyResolver
- 実装されたすべてのインターフェース:
ConfigurablePropertyResolver
,PropertyResolver
- 既知の直属サブクラス
PropertySourcesPropertyResolver
public abstract class AbstractPropertyResolver
extends ObjectSE
implements ConfigurablePropertyResolver
基になるソースに対するプロパティを解決するための抽象基本クラス。
- 導入:
- 3.1
- 作成者:
- Chris Beams, Juergen Hoeller
フィールドサマリー
コンストラクターのサマリー
メソッドのサマリー
修飾子と型メソッド説明boolean
containsProperty
(StringSE key) 指定されたプロパティキーが解決に使用できるかどうかを返します。protected <T> T
convertValueIfNecessary
(ObjectSE value, ClassSE<T> targetType) 必要に応じて、指定された値を指定されたターゲット型に変換します。プロパティの型変換を実行するときに使用されるConfigurableConversionService
を返します。getProperty
(StringSE key) 指定されたキーに関連付けられているプロパティ値を返します。キーを解決できない場合はnull
を返します。<T> T
getProperty
(StringSE key, ClassSE<T> targetType, T defaultValue) 指定されたキーに関連付けられているプロパティ値を返します。キーを解決できない場合はdefaultValue
を返します。getProperty
(StringSE key, StringSE defaultValue) 指定されたキーに関連付けられているプロパティ値を返します。キーを解決できない場合はdefaultValue
を返します。protected abstract StringSE
指定されたプロパティを生の文字列として取得します。指定されたキーに関連付けられているプロパティ値を返します(決してnull
はありません)。<T> T
getRequiredProperty
(StringSE key, ClassSE<T> valueType) 指定されたキーに関連付けられているプロパティ値を、指定された targetType に変換して返します(決してnull
ではありません)。protected StringSE
指定された文字列内のプレースホルダーを解決し、setIgnoreUnresolvableNestedPlaceholders(boolean)
の値を延期して、解決できないプレースホルダーが例外を発生させるか無視するかを決定します。resolvePlaceholders
(StringSE text) 指定されたテキストの ${...} プレースホルダーを解決し、PropertyResolver.getProperty(java.lang.String)
によって解決された対応するプロパティ値に置き換えます。指定されたテキストの ${...} プレースホルダーを解決し、PropertyResolver.getProperty(java.lang.String)
によって解決された対応するプロパティ値に置き換えます。void
setConversionService
(ConfigurableConversionService conversionService) プロパティで型変換を実行するときに使用するConfigurableConversionService
を設定します。void
setIgnoreUnresolvableNestedPlaceholders
(boolean ignoreUnresolvableNestedPlaceholders) 特定のプロパティの値内にネストされた解決できないプレースホルダーに遭遇したときに例外をスローするかどうかを設定します。void
setPlaceholderPrefix
(StringSE placeholderPrefix) このリゾルバーで置き換えられたプレースホルダーが開始する必要がある接頭辞を設定します。void
setPlaceholderSuffix
(StringSE placeholderSuffix) このリゾルバーで置き換えられたプレースホルダーが終了する必要があるサフィックスを設定します。void
setRequiredProperties
(StringSE... requiredProperties) ConfigurablePropertyResolver.validateRequiredProperties()
によって検証される、存在する必要があるプロパティを指定します。void
setValueSeparator
(StringSE valueSeparator) このリゾルバーによって置き換えられたプレースホルダーとそれに関連付けられたデフォルト値の間の区切り文字を指定します。そのような特殊文字を値のセパレーターとして処理する必要がない場合は、null
を指定します。void
ConfigurablePropertyResolver.setRequiredProperties(java.lang.String...)
で指定された各プロパティが存在し、null
以外の値に解決されることを確認します。クラス java.lang.ObjectSE から継承されたメソッド
clone, equalsSE, finalize, getClass, hashCode, notify, notifyAll, toString, wait, waitSE, waitSE
インターフェース org.springframework.core.env.PropertyResolver から継承されたメソッド
getProperty
フィールドの詳細
logger
コンストラクターの詳細
AbstractPropertyResolver
public AbstractPropertyResolver()
メソッドの詳細
getConversionService
インターフェースからコピーされた説明:ConfigurablePropertyResolver
プロパティの型変換を実行するときに使用されるConfigurableConversionService
を返します。返される変換サービスの構成可能な性質により、個々の
Converter
インスタンスを簡単に追加および削除できます。ConfigurableConversionService cs = env.getConversionService(); cs.addConverter(new FooConverter());
setConversionService
インターフェースからコピーされた説明:ConfigurablePropertyResolver
プロパティで型変換を実行するときに使用するConfigurableConversionService
を設定します。注意 :
ConversionService
を完全に置き換える代わりに、ConfigurablePropertyResolver.getConversionService()
にドリルして#addConverter
などのメソッドを呼び出すことにより、個々のConverter
インスタンスを追加または削除することを検討してください。setPlaceholderPrefix
このリゾルバーで置き換えられたプレースホルダーが開始する必要がある接頭辞を設定します。デフォルトは "${" です。
- 次で指定:
- インターフェース
ConfigurablePropertyResolver
のsetPlaceholderPrefix
- 関連事項:
setPlaceholderSuffix
このリゾルバーで置き換えられたプレースホルダーが終了する必要があるサフィックスを設定します。デフォルトは "}" です。
- 次で指定:
- インターフェース
ConfigurablePropertyResolver
のsetPlaceholderSuffix
- 関連事項:
setValueSeparator
このリゾルバーによって置き換えられたプレースホルダーとそれに関連付けられたデフォルト値の間の区切り文字を指定します。そのような特殊文字を値のセパレーターとして処理する必要がない場合は、null
を指定します。デフォルトは ":" です。
- 次で指定:
- インターフェース
ConfigurablePropertyResolver
のsetValueSeparator
- 関連事項:
setIgnoreUnresolvableNestedPlaceholders
public void setIgnoreUnresolvableNestedPlaceholders(boolean ignoreUnresolvableNestedPlaceholders) 特定のプロパティの値内にネストされた解決できないプレースホルダーに遭遇したときに例外をスローするかどうかを設定します。false
値は、厳密な解決、つまり例外がスローされることを示します。true
値は、解決できないネストされたプレースホルダーが、解決されていない ${...} 形式で渡されることを示します。デフォルトは
false
です。- 次で指定:
- インターフェース
ConfigurablePropertyResolver
のsetIgnoreUnresolvableNestedPlaceholders
- 導入:
- 3.2
setRequiredProperties
インターフェースからコピーされた説明:ConfigurablePropertyResolver
ConfigurablePropertyResolver.validateRequiredProperties()
によって検証される、存在する必要があるプロパティを指定します。- 次で指定:
- インターフェース
ConfigurablePropertyResolver
のsetRequiredProperties
validateRequiredProperties
public void validateRequiredProperties()インターフェースからコピーされた説明:ConfigurablePropertyResolver
ConfigurablePropertyResolver.setRequiredProperties(java.lang.String...)
で指定された各プロパティが存在し、null
以外の値に解決されることを確認します。- 次で指定:
- インターフェース
ConfigurablePropertyResolver
のvalidateRequiredProperties
containsProperty
インターフェースからコピーされた説明:PropertyResolver
指定されたプロパティキーが解決に使用できるかどうか、つまり指定されたキーの値がnull
でないかどうかを返します。- 次で指定:
- インターフェース
PropertyResolver
のcontainsProperty
getProperty
インターフェースからコピーされた説明:PropertyResolver
指定されたキーに関連付けられているプロパティ値を返します。キーを解決できない場合はnull
を返します。- 次で指定:
- インターフェース
PropertyResolver
のgetProperty
- パラメーター:
key
- 解決するプロパティ名- 関連事項:
getProperty
インターフェースからコピーされた説明:PropertyResolver
指定されたキーに関連付けられているプロパティ値を返します。キーを解決できない場合はdefaultValue
を返します。- 次で指定:
- インターフェース
PropertyResolver
のgetProperty
- パラメーター:
key
- 解決するプロパティ名defaultValue
- 値が見つからない場合に返すデフォルト値- 関連事項:
getProperty
インターフェースからコピーされた説明:PropertyResolver
指定されたキーに関連付けられているプロパティ値を返します。キーを解決できない場合はdefaultValue
を返します。- 次で指定:
- インターフェース
PropertyResolver
のgetProperty
- パラメーター:
key
- 解決するプロパティ名targetType
- プロパティ値の予想される型defaultValue
- 値が見つからない場合に返すデフォルト値- 関連事項:
getRequiredProperty
インターフェースからコピーされた説明:PropertyResolver
指定されたキーに関連付けられているプロパティ値を返します(決してnull
はありません)。- 次で指定:
- インターフェース
PropertyResolver
のgetRequiredProperty
- 例外:
IllegalStateExceptionSE
- キーを解決できない場合- 関連事項:
getRequiredProperty
インターフェースからコピーされた説明:PropertyResolver
指定されたキーに関連付けられているプロパティ値を、指定された targetType に変換して返します(決してnull
ではありません)。- 次で指定:
- インターフェース
PropertyResolver
のgetRequiredProperty
- 例外:
IllegalStateExceptionSE
- 指定されたキーを解決できない場合
resolvePlaceholders
インターフェースからコピーされた説明:PropertyResolver
指定されたテキストの ${...} プレースホルダーを解決し、PropertyResolver.getProperty(java.lang.String)
によって解決された対応するプロパティ値に置き換えます。デフォルト値のない解決できないプレースホルダーは無視され、変更されずに渡されます。- 次で指定:
- インターフェース
PropertyResolver
のresolvePlaceholders
- パラメーター:
text
- 解決する文字列- 戻り値:
- 解決された文字列 (非
null
) - 関連事項:
resolveRequiredPlaceholders
インターフェースからコピーされた説明:PropertyResolver
指定されたテキストの ${...} プレースホルダーを解決し、PropertyResolver.getProperty(java.lang.String)
によって解決された対応するプロパティ値に置き換えます。デフォルト値のない解決できないプレースホルダーは、IllegalArgumentException をスローします。- 次で指定:
- インターフェース
PropertyResolver
のresolveRequiredPlaceholders
- 戻り値:
- 解決された文字列 (非
null
) - 例外:
IllegalArgumentExceptionSE
- 指定されたテキストがnull
である場合、または解決できないプレースホルダーがある場合
resolveNestedPlaceholders
指定された文字列内のプレースホルダーを解決し、setIgnoreUnresolvableNestedPlaceholders(boolean)
の値を延期して、解決できないプレースホルダーが例外を発生させるか無視するかを決定します。getProperty(java.lang.String)
とそのバリアントから呼び出され、ネストされたプレースホルダーを暗黙的に解決します。対照的に、resolvePlaceholders(java.lang.String)
とresolveRequiredPlaceholders(java.lang.String)
はこのメソッドに委譲せず、これらの各メソッドで指定されているように、解決できないプレースホルダーを独自に処理します。- 導入:
- 3.2
- 関連事項:
convertValueIfNecessary
必要に応じて、指定された値を指定されたターゲット型に変換します。- パラメーター:
value
- 元のプロパティ値targetType
- プロパティ取得用に指定されたターゲット型- 戻り値:
- 変換された値、または変換が不要な場合は元の値
- 導入:
- 4.3.5
getPropertyAsRawString
指定されたプロパティを生の文字列として、つまりネストされたプレースホルダーの解決なしで取得します。- パラメーター:
key
- 解決するプロパティ名- 戻り値:
- プロパティ値。見つからない場合は
null