UriComponentsBuilder (Spring Framework 5.0.0.RELEASE API)

java.lang.ObjectSE
- org.springframework.web.util.UriComponentsBuilder

実装済みのインターフェース一覧:
CloneableSE, UriBuilder
既知の直属サブクラス
ServletUriComponentsBuilder
```
public class UriComponentsBuilder
extends ObjectSE
implements UriBuilder, CloneableSE
```
UriComponents のビルダー。
典型的な使用箇所は次のとおりです。
1. 静的ファクトリメソッドの 1 つで UriComponentsBuilder を作成します (fromPath(String) や fromUri(URI) など)
2. それぞれのメソッド（scheme(String)、userInfo(String)、host(String)、port(int)、path(String)、pathSegment(String...)、queryParam(String, Object...)、fragment(String) を介してさまざまな URI コンポーネントを設定します。
3. build() メソッドを使用して UriComponents インスタンスを構築します。
導入:
3.1
作成者:
Arjen Poutsma, Rossen Stoyanchev, Phillip Webb, Oliver Gierke, Brian Clozel
関連事項:
newInstance(), fromPath(String), fromUri(URI)

コンストラクター概要

コンストラクター
修飾子	コンストラクターと説明
`protected`	`UriComponentsBuilder()` デフォルトコンストラクター。
`protected`	`UriComponentsBuilder(UriComponentsBuilder other)` 指定された UriComponentsBuilder のディープコピーを作成します。

方法の概要

すべてのメソッド静的メソッドインスタンスメソッド具象メソッド
修飾子と型	メソッドと説明
`UriComponents`	`build()` このビルダーに含まれるさまざまなコンポーネントから `UriComponents` インスタンスを構築します。
`UriComponents`	`build(boolean encoded)` このビルダーに含まれるさまざまなコンポーネントから `UriComponents` インスタンスを構築します。
`URISE`	`build(MapSE<StringSE,?> uriVariables)` `URI`SE インスタンスを構築し、URI テンプレート変数をマップの値で置き換えます。
`URISE`	`build(ObjectSE... uriVariables)` `URI`SE インスタンスを構築し、URI テンプレート変数を配列の値で置き換えます。
`UriComponents`	`buildAndExpand(MapSE<StringSE,?> uriVariables)` `UriComponents` インスタンスを作成し、URI テンプレート変数をマップの値で置き換えます。
`UriComponents`	`buildAndExpand(ObjectSE... uriVariableValues)` `UriComponents` インスタンスを構築し、URI テンプレート変数を配列の値で置き換えます。
`ObjectSE`	`clone()` オブジェクトの `clone()` メソッドのパブリック宣言。
`UriComponentsBuilder`	`cloneBuilder()` この `UriComponentsBuilder` を複製します。
`UriComponentsBuilder`	`fragment(StringSE fragment)` URI フラグメントを設定します。
`static UriComponentsBuilder`	`fromHttpRequest(HttpRequest request)` 指定された HttpRequest に関連付けられた URI から新しい `UriComponents` オブジェクトを作成すると同時に、ヘッダー "Forwarded" （RFC 7239）、または "X-Forwarded-Host"、"X-Forwarded-Port"、「X-Forwarded 「転送」が見つからない場合は「プロト」。
`static UriComponentsBuilder`	`fromHttpUrl(StringSE httpUrl)` 指定された HTTP URL 文字列から URI コンポーネントビルダーを作成します。
`static UriComponentsBuilder`	`fromOriginHeader(StringSE origin)` HTTP リクエストの "Origin" ヘッダーを解析してインスタンスを作成します。
`static UriComponentsBuilder`	`fromPath(StringSE path)` 指定されたパスで初期化されるビルダーを作成します。
`static UriComponentsBuilder`	`fromUri(URISE uri)` 指定された `URI` で初期化されるビルダーを作成します。
`static UriComponentsBuilder`	`fromUriString(StringSE uri)` 指定された URI 文字列で初期化されるビルダーを作成します。
`UriComponentsBuilder`	`host(StringSE host)` URI ホストを設定します。
`static UriComponentsBuilder`	`newInstance()` 新しい空のビルダーを作成します。
`UriComponentsBuilder`	`path(StringSE path)` 指定したパスをこのビルダーの既存のパスに追加します。
`UriComponentsBuilder`	`pathSegment(StringSE... pathSegments)` 既存のパスにパスセグメントを追加します。
`UriComponentsBuilder`	`port(int port)` URI ポートを設定します。
`UriComponentsBuilder`	`port(StringSE port)` URI ポートを設定します。
`UriComponentsBuilder`	`query(StringSE query)` 指定されたクエリをこのビルダーの既存のクエリに追加します。
`UriComponentsBuilder`	`queryParam(StringSE name, ObjectSE... values)` 指定されたクエリパラメーターを既存のクエリパラメーターに追加します。
`UriComponentsBuilder`	`queryParams(MultiValueMap<StringSE, StringSE> params)` 指定されたクエリパラメーターを追加します。
`UriComponentsBuilder`	`replacePath(StringSE path)` このビルダーのパスを設定して、既存のすべてのパスおよびパスセグメント値をオーバーライドします。
`UriComponentsBuilder`	`replaceQuery(StringSE query)` このビルダーのクエリを設定して、既存のすべてのクエリパラメーターをオーバーライドします。
`UriComponentsBuilder`	`replaceQueryParam(StringSE name, ObjectSE... values)` 同じパラメーターの既存のすべてのクエリ値をオーバーライドして、クエリパラメーター値を設定します。
`UriComponentsBuilder`	`replaceQueryParams(MultiValueMap<StringSE, StringSE> params)` 既存のすべてのクエリ値をオーバーライドして、クエリパラメーター値を設定します。
`UriComponentsBuilder`	`scheme(StringSE scheme)` URI スキームを設定します。
`UriComponentsBuilder`	`schemeSpecificPart(StringSE ssp)` URI スキーム固有部分を設定します。
`StringSE`	`toUriString()` URI 文字列を作成します。
`UriComponentsBuilder`	`uri(URISE uri)` 指定された URI のコンポーネントからこのビルダーのコンポーネントを初期化します。
`UriComponentsBuilder`	`uriComponents(UriComponents uriComponents)` 指定された `UriComponents` インスタンスの値から、このビルダーの個々の URI コンポーネントを設定または追加します。
`UriComponentsBuilder`	`userInfo(StringSE userInfo)` URI ユーザー情報を設定します。

クラス java.lang.ObjectSE から継承されたメソッド
equalsSE, finalizeSE, getClassSE, hashCodeSE, notifySE, notifyAllSE, toStringSE, waitSE, waitSE, waitSE

- コンストラクターの詳細
  - UriComponentsBuilder
```
protected UriComponentsBuilder()
```
    デフォルトのコンストラクター。直接インスタンス化を防ぐために保護されています。
    関連事項:
    newInstance(), fromPath(String), fromUri(URI)
  - UriComponentsBuilder
```
protected UriComponentsBuilder(UriComponentsBuilder other)
```
    指定された UriComponentsBuilder のディープコピーを作成します。
    パラメーター:
    other - コピー元の他のビルダー
    導入:
    4.1.3
- メソッドの詳細
  - newInstance
```
public static UriComponentsBuilder newInstance()
```
    新しい空のビルダーを作成します。
    戻り値:
    新しい UriComponentsBuilder
  - fromPath
```
public static UriComponentsBuilder fromPath(StringSE path)
```
    指定されたパスで初期化されるビルダーを作成します。
    パラメーター:
    path - 初期化するパス
    戻り値:
    新しい UriComponentsBuilder
  - fromUri
```
public static UriComponentsBuilder fromUri(URISE uri)
```
    指定された URI で初期化されるビルダーを作成します。
    パラメーター:
    uri - 初期化する URI
    戻り値:
    新しい UriComponentsBuilder
  - fromUriString
```
public static UriComponentsBuilder fromUriString(StringSE uri)
```
    指定された URI 文字列で初期化されるビルダーを作成します。
    注意 : 予約文字の存在は、URI 文字列の正しい解析を妨げる可能性があります。たとえば、クエリパラメーターに '=' または '&' 文字が含まれている場合、クエリ文字列を明確に解析することはできません。正しい解析を可能にするために、そのような値を URI 変数に置き換える必要があります。
```
 String uriString = "/hotels/42?filter={value}";
 UriComponentsBuilder.fromUriString(uriString).buildAndExpand("hot&cold");
 
```
    パラメーター:
    uri - 初期化する URI 文字列
    戻り値:
    新しい UriComponentsBuilder
  - fromHttpUrl
```
public static UriComponentsBuilder fromHttpUrl(StringSE httpUrl)
```
    指定された HTTP URL 文字列から URI コンポーネントビルダーを作成します。
    注意 : 予約文字の存在は、URI 文字列の正しい解析を妨げる可能性があります。たとえば、クエリパラメーターに '=' または '&' 文字が含まれている場合、クエリ文字列を明確に解析することはできません。正しい解析を可能にするために、そのような値を URI 変数に置き換える必要があります。
```
 String urlString = "https://example.com/hotels/42?filter={value}";
 UriComponentsBuilder.fromHttpUrl(urlString).buildAndExpand("hot&cold");
 
```
    パラメーター:
    httpUrl - ソース URI
    戻り値:
    URI の URI コンポーネント
  - fromHttpRequest
```
public static UriComponentsBuilder fromHttpRequest(HttpRequest request)
```
    指定された HttpRequest に関連付けられた URI から新しい UriComponents オブジェクトを作成すると同時に、ヘッダー "Forwarded" （RFC 7239）、または "X-Forwarded-Host"、"X-Forwarded-Port"、「X-Forwarded 「転送」が見つからない場合は「プロト」。
    パラメーター:
    request - ソースリクエスト
    戻り値:
    URI の URI コンポーネント
    導入:
    4.1.5
  - fromOriginHeader
```
public static UriComponentsBuilder fromOriginHeader(StringSE origin)
```
    HTTP リクエストの "Origin" ヘッダーを解析してインスタンスを作成します。
    関連事項:
    RFC 6454
  - build
```
public UriComponents build()
```
    このビルダーに含まれるさまざまなコンポーネントから UriComponents インスタンスを構築します。
    戻り値:
    URI コンポーネント
  - build
```
public UriComponents build(boolean encoded)
```
    このビルダーに含まれるさまざまなコンポーネントから UriComponents インスタンスを構築します。
    パラメーター:
    encoded - このビルダーで設定されたすべてのコンポーネントがエンコードされているか（true） (false)
    戻り値:
    URI コンポーネント
  - buildAndExpand
```
public UriComponents buildAndExpand(MapSE<StringSE,?> uriVariables)
```
    UriComponents インスタンスを作成し、URI テンプレート変数をマップの値で置き換えます。これは、build() への呼び出しと UriComponents.expand(Map) への呼び出しを組み合わせたショートカットメソッドです。
    パラメーター:
    uriVariables - URI 変数のマップ
    戻り値:
    拡張された値を持つ URI コンポーネント
  - buildAndExpand
```
public UriComponents buildAndExpand(ObjectSE... uriVariableValues)
```
    UriComponents インスタンスを構築し、URI テンプレート変数を配列の値で置き換えます。これは、build() への呼び出しと UriComponents.expand(Object...) への呼び出しを組み合わせたショートカットメソッドです。
    パラメーター:
    uriVariableValues - URI 変数値
    戻り値:
    拡張された値を持つ URI コンポーネント
  - build
```
public URISE build(ObjectSE... uriVariables)
```
    URISE インスタンスを構築し、URI テンプレート変数を配列の値で置き換えます。
    次で指定:
    インターフェース UriBuilder 内の build
    パラメーター:
    uriVariables - URI 変数のマップ
    戻り値:
    URI
  - build
```
public URISE build(MapSE<StringSE,?> uriVariables)
```
    URISE インスタンスを構築し、URI テンプレート変数をマップの値で置き換えます。
    次で指定:
    インターフェース UriBuilder 内の build
    パラメーター:
    uriVariables - URI 変数のマップ
    戻り値:
    URI
  - toUriString
```
public StringSE toUriString()
```
    URI 文字列を作成します。これは、build()、次に UriComponents.encode()、最後に UriComponents.toUriString() の呼び出しを組み合わせるショートカットメソッドです。
    導入:
    4.1
    関連事項:
    UriComponents.toUriString()
  - uri
```
public UriComponentsBuilder uri(URISE uri)
```
    指定された URI のコンポーネントからこのビルダーのコンポーネントを初期化します。
    パラメーター:
    uri - URI
    戻り値:
    この UriComponentsBuilder
  - uriComponents
```
public UriComponentsBuilder uriComponents(UriComponents uriComponents)
```
    指定された UriComponents インスタンスの値から、このビルダーの個々の URI コンポーネントを設定または追加します。
    各コンポーネントのセマンティクス（つまり、設定と追加）については、このクラスのビルダーメソッドを確認してください。たとえば、host(String) が設定され、path(String) が追加されます。
    パラメーター:
    uriComponents - コピー元の UriComponents
    戻り値:
    この UriComponentsBuilder
  - scheme
```
public UriComponentsBuilder scheme(@Nullable
                                   StringSE scheme)
```
    URI スキームを設定します。指定されたスキームには URI テンプレート変数を含めることができ、このビルダーのスキームをクリアするために null にすることもできます。
    次で指定:
    インターフェース UriBuilder 内の scheme
    パラメーター:
    scheme - URI スキーム
    戻り値:
    この UriComponentsBuilder
  - schemeSpecificPart
```
public UriComponentsBuilder schemeSpecificPart(StringSE ssp)
```
    URI スキーム固有部分を設定します。呼び出されると、このメソッドは user-info、host、port、path、および query を上書きします。
    パラメーター:
    ssp - URI スキーム固有部分には、URI テンプレートパラメーターが含まれる場合があります
    戻り値:
    この UriComponentsBuilder
  - userInfo
```
public UriComponentsBuilder userInfo(@Nullable
                                     StringSE userInfo)
```
    URI ユーザー情報を設定します。指定されたユーザー情報には URI テンプレート変数が含まれる場合があり、このビルダーのユーザー情報をクリアするために null になる場合もあります。
    次で指定:
    インターフェース UriBuilder 内の userInfo
    パラメーター:
    userInfo - URI ユーザー情報
    戻り値:
    この UriComponentsBuilder
  - host
```
public UriComponentsBuilder host(@Nullable
                                 StringSE host)
```
    URI ホストを設定します。指定されたホストには URI テンプレート変数を含めることができ、このビルダーのホストをクリアするために null にすることもできます。
    次で指定:
    インターフェース UriBuilder 内の host
    パラメーター:
    host - URI ホスト
    戻り値:
    この UriComponentsBuilder
  - port
```
public UriComponentsBuilder port(int port)
```
    URI ポートを設定します。-1 を渡すと、このビルダーのポートがクリアされます。
    次で指定:
    インターフェース UriBuilder 内の port
    パラメーター:
    port - URI ポート
    戻り値:
    この UriComponentsBuilder
  - port
```
public UriComponentsBuilder port(@Nullable
                                 StringSE port)
```
    URI ポートを設定します。このメソッドは、ポートを URI 変数でパラメーター化する必要がある場合にのみ使用してください。それ以外の場合は、port(int) を使用します。null を渡すと、このビルダーのポートがクリアされます。
    次で指定:
    インターフェース UriBuilder 内の port
    パラメーター:
    port - URI ポート
    戻り値:
    この UriComponentsBuilder
  - path
```
public UriComponentsBuilder path(StringSE path)
```
    指定したパスをこのビルダーの既存のパスに追加します。指定されたパスには、URI テンプレート変数を含めることができます。
    次で指定:
    インターフェース UriBuilder 内の path
    パラメーター:
    path - URI パス
    戻り値:
    この UriComponentsBuilder
  - pathSegment
```
public UriComponentsBuilder pathSegment(StringSE... pathSegments)
                                 throws IllegalArgumentExceptionSE
```
    既存のパスにパスセグメントを追加します。各パスセグメントには URI テンプレート変数を含めることができますが、スラッシュを含めることはできません。続いて path("/") を使用して、末尾のスラッシュを確認します。
    次で指定:
    インターフェース UriBuilder 内の pathSegment
    パラメーター:
    pathSegments - URI パスセグメント
    戻り値:
    この UriComponentsBuilder
    例外:
    IllegalArgumentExceptionSE
  - replacePath
```
public UriComponentsBuilder replacePath(@Nullable
                                        StringSE path)
```
    このビルダーのパスを設定して、既存のすべてのパスおよびパスセグメント値をオーバーライドします。
    次で指定:
    インターフェース UriBuilder 内の replacePath
    パラメーター:
    path - URI パス (null 値は空のパスになります)
    戻り値:
    この UriComponentsBuilder
  - query
```
public UriComponentsBuilder query(@Nullable
                                  StringSE query)
```
    指定されたクエリをこのビルダーの既存のクエリに追加します。指定されたクエリには URI テンプレート変数が含まれる場合があります。
    注意 : 予約文字の存在は、URI 文字列の正しい解析を妨げる可能性があります。たとえば、クエリパラメーターに '=' または '&' 文字が含まれている場合、クエリ文字列を明確に解析することはできません。正しい解析を可能にするために、そのような値を URI 変数に置き換える必要があります。
```
 UriComponentsBuilder.fromUriString("/hotels/42")
        .query("filter={value}")
        .buildAndExpand("hot&cold");
 
```
    次で指定:
    インターフェース UriBuilder 内の query
    パラメーター:
    query - クエリ文字列
    戻り値:
    この UriComponentsBuilder
  - replaceQuery
```
public UriComponentsBuilder replaceQuery(@Nullable
                                         StringSE query)
```
    このビルダーのクエリを設定して、既存のすべてのクエリパラメーターをオーバーライドします。
    次で指定:
    インターフェース UriBuilder 内の replaceQuery
    パラメーター:
    query - クエリ文字列。null 値は、すべてのクエリパラメーターを削除します。
    戻り値:
    この UriComponentsBuilder
  - queryParam
```
public UriComponentsBuilder queryParam(StringSE name,
                                       ObjectSE... values)
```
    指定されたクエリパラメーターを既存のクエリパラメーターに追加します。指定された名前または任意の値には、URI テンプレート変数を含めることができます。値が指定されていない場合、結果の URI にはクエリパラメーター名のみが含まれます（つまり、?foo=bar ではなく ?foo になります）。
    次で指定:
    インターフェース UriBuilder 内の queryParam
    パラメーター:
    name - クエリパラメーター名
    values - クエリパラメーター値
    戻り値:
    この UriComponentsBuilder
  - queryParams
```
public UriComponentsBuilder queryParams(@Nullable
                                        MultiValueMap<StringSE,StringSE> params)
```
    指定されたクエリパラメーターを追加します。
    次で指定:
    インターフェース UriBuilder 内の queryParams
    パラメーター:
    params - パラメーター
    戻り値:
    この UriComponentsBuilder
    導入:
    4.0
  - replaceQueryParam
```
public UriComponentsBuilder replaceQueryParam(StringSE name,
                                              ObjectSE... values)
```
    同じパラメーターの既存のすべてのクエリ値をオーバーライドして、クエリパラメーター値を設定します。値が指定されていない場合、クエリパラメーターは削除されます。
    次で指定:
    インターフェース UriBuilder 内の replaceQueryParam
    パラメーター:
    name - クエリパラメーター名
    values - クエリパラメーター値
    戻り値:
    この UriComponentsBuilder
  - replaceQueryParams
```
public UriComponentsBuilder replaceQueryParams(@Nullable
                                               MultiValueMap<StringSE,StringSE> params)
```
    既存のすべてのクエリ値をオーバーライドして、クエリパラメーター値を設定します。
    次で指定:
    インターフェース UriBuilder 内の replaceQueryParams
    パラメーター:
    params - クエリパラメーター名
    戻り値:
    この UriComponentsBuilder
    導入:
    4.2
  - fragment
```
public UriComponentsBuilder fragment(@Nullable
                                     StringSE fragment)
```
    URI フラグメントを設定します。指定されたフラグメントには URI テンプレート変数が含まれる場合があり、このビルダーのフラグメントをクリアするために null になる場合もあります。
    次で指定:
    インターフェース UriBuilder 内の fragment
    パラメーター:
    fragment - URI フラグメント
    戻り値:
    この UriComponentsBuilder
  - clone
```
public ObjectSE clone()
```
    オブジェクトの clone() メソッドのパブリック宣言。cloneBuilder() へのデリゲート。
    オーバーライド:
    クラス ObjectSE の cloneSE
  - cloneBuilder
```
public UriComponentsBuilder cloneBuilder()
```
    この UriComponentsBuilder を複製します。
    戻り値:
    クローン化された UriComponentsBuilder オブジェクト
    導入:
    4.2.7

クラス UriComponentsBuilder

コンストラクター概要

方法の概要

クラス java.lang.ObjectSE から継承されたメソッド

コンストラクターの詳細

UriComponentsBuilder

UriComponentsBuilder

メソッドの詳細

newInstance

fromPath

fromUri

fromUriString

fromHttpUrl

fromHttpRequest

fromOriginHeader

build

build

buildAndExpand

buildAndExpand

build

build

toUriString

uri

uriComponents

scheme

schemeSpecificPart

userInfo

host

port

port

path

pathSegment

replacePath

query

replaceQuery

queryParam

queryParams

replaceQueryParam

replaceQueryParams

fragment

clone

cloneBuilder