クラス ConfigurationPropertyName
java.lang.ObjectSE
org.springframework.boot.context.properties.source.ConfigurationPropertyName
- 実装されたすべてのインターフェース:
ComparableSE<ConfigurationPropertyName>
public final class ConfigurationPropertyName
extends ObjectSE
implements ComparableSE<ConfigurationPropertyName>
ドットで区切られた要素で構成される構成プロパティ名。ユーザーが作成した名前には、"
a-z
" "0-9
" )および "-
" の文字を含めることができます。これらは小文字で、英数字で始まる必要があります。"-
" は純粋にフォーマットに使用されます。つまり、"foo-bar
" と "foobar
" は同等と見なされます。 "[
" および "]
" 文字は、連想インデックス(たとえば、Map
SE キーまたは Collection
SE インデックス)を示すために使用され得ます。インデックス名は制限されておらず、大文字と小文字が区別されると見なされます。
ここにいくつかの典型的な例があります:
spring.main.banner-mode
server.hosts[0].name
log[org.springboot].level
- 導入:
- 2.0.0
- 作成者:
- Phillip Webb, Madhura Bhave
- 関連事項:
ネストされたクラスのサマリー
ネストされたクラスフィールドサマリー
フィールドメソッドのサマリー
修飾子と型メソッド説明static ConfigurationPropertyName
adapt
(CharSequenceSE name, char separator) 指定されたソースを調整してConfigurationPropertyName
を作成します。指定されたサフィックスを追加して、新しいConfigurationPropertyName
を作成します。append
(ConfigurationPropertyName suffix) 指定されたサフィックスを追加して、新しいConfigurationPropertyName
を作成します。chop
(int size) この名前を指定されたsize
にチョップして、新しいConfigurationPropertyName
を返します。int
boolean
getElement
(int elementIndex, ConfigurationPropertyName.Form form) 名前の要素を指定された形式で返します。名前の最後の要素を指定された形式で返します。int
名前の要素の総数を返します。親がない場合は、このConfigurationPropertyName
またはEMPTY
の親を返します。int
hashCode()
boolean
名前の要素にインデックスが付けられている場合、true
を返します。boolean
この要素が指定された名前の祖先(直接またはネストされた親)である場合、true
を返します。boolean
isEmpty()
このConfigurationPropertyName
が空の場合、true
を返します。boolean
名前の最後の要素にインデックスが付けられている場合に返します。boolean
isNumericIndex
(int elementIndex) 名前の要素がインデックス付きで数値の場合に返します。boolean
この要素が指定した名前の直接の親である場合、true
を返します。static boolean
isValid
(CharSequenceSE name) 指定された名前が有効かどうかを返します。static ConfigurationPropertyName
of
(CharSequenceSE name) 指定された文字列のConfigurationPropertyName
を返します。static ConfigurationPropertyName
ofIfValid
(CharSequenceSE name) 指定された文字列のConfigurationPropertyName
を返します。名前が無効な場合はnull
を返します。subName
(int offset) 特定の要素インデックスによってオフセットされたこの名前に基づいて、新しいConfigurationPropertyName
を返します。toString()
フィールドの詳細
EMPTY
メソッドの詳細
isEmpty
public boolean isEmpty()このConfigurationPropertyName
が空の場合、true
を返します。- 戻り値:
true
(名前が空の場合)
isLastElementIndexed
public boolean isLastElementIndexed()名前の最後の要素にインデックスが付けられている場合に返します。- 戻り値:
true
(最後の要素にインデックスが付けられている場合)
hasIndexedElement
public boolean hasIndexedElement()名前の要素にインデックスが付けられている場合、true
を返します。- 戻り値:
- 要素に 1 つ以上のインデックス付き要素がある場合
- 導入:
- 2.2.10
isNumericIndex
public boolean isNumericIndex(int elementIndex) 名前の要素がインデックス付きで数値の場合に返します。- パラメーター:
elementIndex
- 要素のインデックス- 戻り値:
- 要素がインデックス付きで数値の場合は
true
getLastElement
名前の最後の要素を指定された形式で返します。- パラメーター:
form
- 返すフォーム- 戻り値:
- 最後の要素
getElement
名前の要素を指定された形式で返します。- パラメーター:
elementIndex
- 要素のインデックスform
- 返すフォーム- 戻り値:
- 最後の要素
getNumberOfElements
public int getNumberOfElements()名前の要素の総数を返します。- 戻り値:
- 要素の数
append
指定されたサフィックスを追加して、新しいConfigurationPropertyName
を作成します。- パラメーター:
suffix
- 追加する要素- 戻り値:
- 新しい
ConfigurationPropertyName
- 例外:
InvalidConfigurationPropertyNameException
- 結果が有効でない場合
append
指定されたサフィックスを追加して、新しいConfigurationPropertyName
を作成します。- パラメーター:
suffix
- 追加する要素- 戻り値:
- 新しい
ConfigurationPropertyName
- 導入:
- 2.5.0
getParent
親がない場合は、このConfigurationPropertyName
またはEMPTY
の親を返します。- 戻り値:
- 親の名前
chop
- パラメーター:
size
- 刻むサイズ- 戻り値:
- みじん切りの名前
subName
特定の要素インデックスによってオフセットされたこの名前に基づいて、新しいConfigurationPropertyName
を返します。例:foo.bar
という名前のchop(1)
は、bar
を返します。- パラメーター:
offset
- 要素のオフセット- 戻り値:
- サブ名
- 導入:
- 2.5.0
isParentOf
この要素が指定した名前の直接の親である場合、true
を返します。- パラメーター:
name
- チェックする名前- 戻り値:
- この名前が祖先の場合は
true
isAncestorOf
この要素が指定された名前の祖先(直接またはネストされた親)である場合、true
を返します。- パラメーター:
name
- チェックする名前- 戻り値:
- この名前が祖先の場合は
true
compareTo
- 次で指定:
- インターフェース
ComparableSE<ConfigurationPropertyName>
のcompareToSE
equals
hashCode
public int hashCode()toString
isValid
指定された名前が有効かどうかを返します。このメソッドがtrue
を返す場合、その名前は例外をスローせずにof(CharSequence)
で使用できます。- パラメーター:
name
- テストする名前- 戻り値:
- 名前が有効な場合は
true
of
指定された文字列のConfigurationPropertyName
を返します。- パラメーター:
name
- ソース名- 戻り値:
ConfigurationPropertyName
インスタンス- 例外:
InvalidConfigurationPropertyNameException
- 名前が無効な場合
ofIfValid
指定された文字列のConfigurationPropertyName
を返します。名前が無効な場合はnull
を返します。- パラメーター:
name
- ソース名- 戻り値:
ConfigurationPropertyName
インスタンス- 導入:
- 2.3.1
adapt
与えられたソースを適応させてConfigurationPropertyName
を作成します。詳細については、adapt(CharSequence, char, Function)
を参照してください。- パラメーター:
name
- 解析する名前separator
- 名前を分割するために使用されるセパレータ- 戻り値:
ConfigurationPropertyName