クラス UriComponents

java.lang.ObjectSE
org.springframework.web.util.UriComponents
実装されたすべてのインターフェース:
SerializableSE

public abstract class UriComponents extends ObjectSE implements SerializableSE
URI コンポーネントの不変のコレクションを表し、コンポーネント型を文字列値にマッピングします。すべてのコンポーネントの便利な getter が含まれています。事実上 URISE に似ていますが、より強力なエンコードオプションと URI テンプレート変数のサポートを備えています。
導入:
3.1
作成者:
Arjen Poutsma, Juergen Hoeller, Rossen Stoyanchev
関連事項:
  • コンストラクターの詳細

  • メソッドの詳細

    • getScheme

      @Nullable public final StringSE getScheme()
      スキームを返します。null にすることができます。
    • getFragment

      @Nullable public final StringSE getFragment()
      フラグメントを返します。null にすることができます。
    • getSchemeSpecificPart

      @Nullable public abstract StringSE getSchemeSpecificPart()
      スキーム固有の部分を返します。null にすることができます。
    • getUserInfo

      @Nullable public abstract StringSE getUserInfo()
      ユーザー情報を返します。null にすることができます。
    • getHost

      @Nullable public abstract StringSE getHost()
      ホストを返します。null にすることができます。
    • getPort

      public abstract int getPort()
      ポートを返します。ポートが設定されていない場合は、-1
    • getPath

      @Nullable public abstract StringSE getPath()
      パスを返します。null にすることができます。
    • getPathSegments

      public abstract ListSE<StringSE> getPathSegments()
      パスセグメントのリストを返します。パスが設定されていない場合は空です。
    • getQuery

      @Nullable public abstract StringSE getQuery()
      クエリを返します。null にすることができます。
    • getQueryParams

      public abstract MultiValueMap<StringSE,StringSE> getQueryParams()
      クエリパラメーターのマップを返します。クエリが設定されていない場合は空です。
    • encode

      public final UriComponents encode()
      URI 変数を展開した後、これ呼び出して、結果の URI コンポーネント値をエンコードします。

      UriComponentsBuilder.encode() と比較すると、このメソッドは、非 ASCII 文字および無効な(指定された URI コンポーネント型内の)文字のみを置き換えますが、意味が予約されている文字は置き換えません。ほとんどの場合、UriComponentsBuilder.encode() は期待される結果を与える可能性が高くなります。

      関連事項:
    • encode

      public abstract UriComponents encode(CharsetSE charset)
      "UTF-8" 以外の文字セットを持つ encode() のバリアント。
      パラメーター:
      charset - エンコードに使用する文字セット
      関連事項:
    • expand

      public final UriComponents expand(MapSE<StringSE,?> uriVariables)
      すべての URI テンプレート変数を特定のマップの値に置き換えます。

      指定されたマップキーは変数名を表します。対応する値は変数値を表します。変数の順序は重要ではありません。

      パラメーター:
      uriVariables - URI 変数のマップ
      戻り値:
      展開された URI コンポーネント
    • expand

      public final UriComponents expand(ObjectSE... uriVariableValues)
      すべての URI テンプレート変数を特定の配列の値に置き換えます。

      指定された配列は変数値を表します。変数の順序は重要です。

      パラメーター:
      uriVariableValues - URI 変数値
      戻り値:
      展開された URI コンポーネント
    • expand

      public final UriComponents expand(UriComponents.UriTemplateVariables uriVariables)
      すべての URI テンプレート変数を、指定された UriComponents.UriTemplateVariables の値に置き換えます。
      パラメーター:
      uriVariables - URI テンプレート値
      戻り値:
      展開された URI コンポーネント
    • normalize

      public abstract UriComponents normalize()
      "path/.." のようなシーケンスを削除してパスを正規化します。正規化は、個々のパスセグメントではなく、フルパスに適用されることに注意してください。
      関連事項:
    • toUriString

      public abstract StringSE toUriString()
      すべての URI コンポーネントを連結して、完全に形成された URI 文字列を返します。

      このメソッドは、現在の URI コンポーネント値の単純な文字列連結に相当するため、たとえば URI 変数が展開されていない場合や、UriComponentsBuilder.encode() または encode() を介してエンコードが適用されていない場合、結果に不正な URI 文字が含まれる可能性があります。

    • toUri

      public abstract URISE toUri()
      次のようにして、このインスタンスから URISE を作成します。

      現在のインスタンスが encoded の場合、toUriString() を介して完全な URI 文字列を形成し、パーセントエンコーディングを保持する単一の引数 URISE コンストラクターに渡します。

      まだエンコードされていない場合は、個々の URI コンポーネントの値を複数の引数 URISE コンストラクターに渡します。このコンストラクターは、それぞれの URI コンポーネントに表示できない不正な文字を引用します。

    • toString

      public final StringSE toString()
      toUriString() への単純なパススルー。
      オーバーライド:
      クラス ObjectSEtoString 
    • copyToUriComponentsBuilder

      protected abstract void copyToUriComponentsBuilder(UriComponentsBuilder builder)
      指定された UriComponentsBuilder のすべてのコンポーネントを設定します。
      導入:
      4.2