クラス 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" は同等と見なされます。

"[" および "]" 文字は、連想インデックス（たとえば、MapSE キーまたは CollectionSE インデックス）を示すために使用され得ます。インデックス名は制限されておらず、大文字と小文字が区別されると見なされます。

ここにいくつかの典型的な例があります:

  • spring.main.banner-mode
  • server.hosts[0].name
  • log[org.springboot].level
導入:
2.0.0
作成者:
Phillip Webb, Madhura Bhave
関連事項:

  • フィールドの詳細

  • メソッドの詳細

    • 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

      public StringSE getLastElement(ConfigurationPropertyName.Form form)
      名前の最後の要素を指定された形式で返します。
      パラメーター:
      form - 返すフォーム
      戻り値:
      最後の要素

    • getElement

      public StringSE getElement(int elementIndex, ConfigurationPropertyName.Form form)
      名前の要素を指定された形式で返します。
      パラメーター:
      elementIndex - 要素のインデックス
      form - 返すフォーム
      戻り値:
      最後の要素

    • getNumberOfElements

      public int getNumberOfElements()
      名前の要素の総数を返します。
      戻り値:
      要素の数

    • append

      public ConfigurationPropertyName append(@Nullable StringSE suffix)
      指定されたサフィックスを追加して、新しい ConfigurationPropertyName を作成します。
      パラメーター:
      suffix - 追加する要素
      戻り値:
      新しい ConfigurationPropertyName
      例外:
      InvalidConfigurationPropertyNameException - 結果が有効でない場合

    • append

      public ConfigurationPropertyName append(@Nullable ConfigurationPropertyName suffix)
      指定されたサフィックスを追加して、新しい ConfigurationPropertyName を作成します。
      パラメーター:
      suffix - 追加する要素
      戻り値:
      新しい ConfigurationPropertyName
      導入:
      2.5.0

    • getParent

      public ConfigurationPropertyName getParent()
      親がない場合は、この ConfigurationPropertyName または EMPTY の親を返します。
      戻り値:
      親の名前

    • chop

      public ConfigurationPropertyName chop(int size)
      この名前を指定された size に切り刻んで、新しい ConfigurationPropertyName を返します。例: foo.bar という名前の chop(1) は、foo を返します。
      パラメーター:
      size - 刻むサイズ
      戻り値:
      みじん切りの名前

    • subName

      public ConfigurationPropertyName subName(int offset)
      特定の要素インデックスによってオフセットされたこの名前に基づいて、新しい ConfigurationPropertyName を返します。例: foo.bar という名前の subName(1) は、bar を返します。
      パラメーター:
      offset - 要素のオフセット
      戻り値:
      サブ名
      導入:
      2.5.0

    • isParentOf

      public boolean isParentOf(ConfigurationPropertyName name)
      この要素が指定した名前の直接の親である場合、true を返します。
      パラメーター:
      name - チェックする名前
      戻り値:
      この名前が祖先の場合は true 

    • isAncestorOf

      public boolean isAncestorOf(ConfigurationPropertyName name)
      この要素が指定された名前の祖先（直接またはネストされた親）である場合、true を返します。
      パラメーター:
      name - チェックする名前
      戻り値:
      この名前が祖先の場合は true 

    • compareTo

      public int compareTo(ConfigurationPropertyName other)
      次で指定:
      インターフェース ComparableSE<ConfigurationPropertyName> の compareToSE 

    • equals

      public boolean equals(ObjectSE obj)
      オーバーライド:
      クラス ObjectSE の equalsSE 

    • hashCode

      public int hashCode()
      オーバーライド:
      クラス ObjectSE の hashCode 

    • toString

      public StringSE toString()
      オーバーライド:
      クラス ObjectSE の toString 

    • isValid

      public static boolean isValid(@Nullable CharSequenceSE name)
      指定された名前が有効かどうかを返します。このメソッドが true を返す場合、その名前は例外をスローせずに of(CharSequence) で使用できます。
      パラメーター:
      name - テストする名前
      戻り値:
      名前が有効な場合は true 

    • of

      public static ConfigurationPropertyName of(@Nullable CharSequenceSE name)
      指定された文字列の ConfigurationPropertyName を返します。
      パラメーター:
      name - ソース名
      戻り値:
      ConfigurationPropertyName インスタンス
      例外:
      InvalidConfigurationPropertyNameException - 名前が無効な場合

    • ofIfValid

      public static @Nullable ConfigurationPropertyName ofIfValid(@Nullable CharSequenceSE name)
      指定された文字列の ConfigurationPropertyName を返します。名前が無効な場合は null を返します。
      パラメーター:
      name - ソース名
      戻り値:
      ConfigurationPropertyName インスタンス
      導入:
      2.3.1

    • adapt

      public static ConfigurationPropertyName adapt(CharSequenceSE name, char separator)
      与えられたソースを適応させて ConfigurationPropertyName を作成します。詳細については、adapt(CharSequence, char, Function) を参照してください。
      パラメーター:
      name - 解析する名前
      separator - 名前を分割するために使用されるセパレータ
      戻り値:
      ConfigurationPropertyName