クラス UriComponents
java.lang.ObjectSE
org.springframework.web.util.UriComponents
- 実装されているすべてのインターフェース:
SerializableSE
URI コンポーネントの不変のコレクションを表し、コンポーネント型を文字列値にマッピングします。すべてのコンポーネントの便利な getter が含まれています。事実上
URISE に似ていますが、より強力なエンコードオプションと URI テンプレート変数のサポートを備えています。- 導入:
- 3.1
- 作成者:
- Arjen Poutsma, Juergen Hoeller, Rossen Stoyanchev
- 関連事項:
ネストされたクラスの要約
ネストされたクラスコンストラクターの概要
コンストラクターメソッドのサマリー
修飾子と型メソッド説明protected abstract void指定された UriComponentsBuilder のすべてのコンポーネントを設定します。final UriComponentsencode()URI 変数を展開した後、これを呼び出して、結果の URI コンポーネント値をエンコードします。abstract UriComponents"UTF-8" 以外の文字セットを持つencode()のバリアント。final UriComponentsすべての URI テンプレート変数を特定の配列の値に置き換えます。final UriComponentsすべての URI テンプレート変数を特定のマップの値に置き換えます。final UriComponentsexpand(UriComponents.UriTemplateVariables uriVariables) すべての URI テンプレート変数を、指定されたUriComponents.UriTemplateVariablesの値に置き換えます。final StringSEフラグメントを返します。abstract StringSEgetHost()ホストを返します。abstract StringSEgetPath()パスを返します。パスセグメントのリストを返します。abstract intgetPort()ポートを返します。abstract StringSEgetQuery()クエリを返します。abstract MultiValueMap<StringSE,StringSE> クエリパラメーターのマップを返します。final StringSEスキームを返します。abstract StringSEスキーム固有の部分を返します。abstract StringSEユーザー情報を返します。abstract UriComponents"path/.." のようなシーケンスを削除してパスを正規化します。final StringSEtoString()toUriString()への単純なパススルー。abstract URISEtoUri()次のようにして、このインスタンスからURISE を作成します。abstract StringSEすべての URI コンポーネントを連結して、完全に形成された URI 文字列を返します。
コンストラクターの詳細
UriComponents
メソッドの詳細
getScheme
スキームを返します。nullにすることができます。getFragment
フラグメントを返します。nullにすることができます。getSchemeSpecificPart
スキーム固有の部分を返します。nullにすることができます。getUserInfo
ユーザー情報を返します。nullにすることができます。getHost
ホストを返します。nullにすることができます。getPort
public abstract int getPort()ポートを返します。ポートが設定されていない場合は、-1。getPath
パスを返します。nullにすることができます。getPathSegments
パスセグメントのリストを返します。パスが設定されていない場合は空です。getQuery
クエリを返します。nullにすることができます。getQueryParams
クエリパラメーターのマップを返します。クエリが設定されていない場合は空です。encode
URI 変数を展開した後、これを呼び出して、結果の URI コンポーネント値をエンコードします。UriComponentsBuilder.encode()と比較すると、このメソッドは、非 ASCII 文字および無効な(指定された URI コンポーネント型内の)文字のみを置き換えますが、意味が予約されている文字は置き換えません。ほとんどの場合、UriComponentsBuilder.encode()は期待される結果を与える可能性が高くなります。encode
"UTF-8" 以外の文字セットを持つencode()のバリアント。- パラメーター:
charset- エンコードに使用する文字セット- 関連事項:
expand
すべての URI テンプレート変数を特定のマップの値に置き換えます。指定されたマップキーは変数名を表します。対応する値は変数値を表します。変数の順序は重要ではありません。
- パラメーター:
uriVariables- URI 変数のマップ- 戻り値:
- 展開された URI コンポーネント
expand
すべての URI テンプレート変数を特定の配列の値に置き換えます。指定された配列は変数値を表します。変数の順序は重要です。
- パラメーター:
uriVariableValues- URI 変数値- 戻り値:
- 展開された URI コンポーネント
expand
すべての URI テンプレート変数を、指定されたUriComponents.UriTemplateVariablesの値に置き換えます。- パラメーター:
uriVariables- URI テンプレート値- 戻り値:
- 展開された URI コンポーネント
normalize
"path/.." のようなシーケンスを削除してパスを正規化します。正規化は、個々のパスセグメントではなく、フルパスに適用されることに注意してください。toUriString
すべての URI コンポーネントを連結して、完全に形成された URI 文字列を返します。このメソッドは、現在の URI コンポーネント値の単純な文字列連結に相当するため、たとえば URI 変数が展開されていない場合や、
UriComponentsBuilder.encode()またはencode()を介してエンコードが適用されていない場合、結果に不正な URI 文字が含まれる可能性があります。toUri
次のようにして、このインスタンスからURISE を作成します。現在のインスタンスが
encodedの場合、toUriString()を介して完全な URI 文字列を形成し、パーセントエンコーディングを保持する単一の引数URISE コンストラクターに渡します。まだエンコードされていない場合は、個々の URI コンポーネントの値を複数の引数
URISE コンストラクターに渡します。このコンストラクターは、それぞれの URI コンポーネントに表示できない不正な文字を引用します。toString
toUriString()への単純なパススルー。copyToUriComponentsBuilder
指定された UriComponentsBuilder のすべてのコンポーネントを設定します。- 導入:
- 4.2