public interface UriBuilder
実質的に UriComponentsBuilder
の一般化ですが、UriComponents
ではなく URI
に直接展開するショートカットがあり、エンコーディングの設定、ベース URI などの一般的な関心事を実装の関心事として残しています。
通常、一度構成され、多くの URL を作成するために使用される主要コンポーネントとして機能する UriBuilderFactory
を介して取得されます。
UriBuilderFactory
, UriComponentsBuilder
修飾子と型 | メソッドと説明 |
---|---|
java.net.URI | build(java.util.Map<java.lang.String,?> uriVariables) URI インスタンスを作成し、URI テンプレート変数をマップの値で置き換えます。 |
java.net.URI | build(java.lang.Object... uriVariables) URI インスタンスを構築し、URI テンプレート変数を配列の値で置き換えます。 |
UriBuilder | fragment(java.lang.String fragment) URI フラグメントを設定します。 |
UriBuilder | host(java.lang.String host) URI テンプレート変数を含む URI ホストを設定します。このビルダーのホストをクリアするには、 null にすることもできます。 |
UriBuilder | path(java.lang.String path) 指定したパスをこのビルダーの既存のパスに追加します。 |
UriBuilder | pathSegment(java.lang.String... pathSegments) 既存のパスにパスセグメントを追加します。 |
UriBuilder | port(int port) URI ポートを設定します。 |
UriBuilder | port(java.lang.String port) URI ポートを設定します。 |
UriBuilder | query(java.lang.String query) 指定されたクエリをこのビルダーの既存のクエリに追加します。 |
UriBuilder | queryParam(java.lang.String name, java.lang.Object... values) 指定されたクエリパラメーターを既存のクエリパラメーターに追加します。 |
UriBuilder | queryParams(MultiValueMap<java.lang.String,java.lang.String> params) 指定されたクエリパラメーターを追加します。 |
UriBuilder | replacePath(java.lang.String path) 既存のパス値をオーバーライドして、このビルダーのパスを設定します。 |
UriBuilder | replaceQuery(java.lang.String query) このビルダーのクエリを設定して、既存のすべてのクエリパラメーターをオーバーライドします。 |
UriBuilder | replaceQueryParam(java.lang.String name, java.lang.Object... values) 同じパラメーターの既存のすべてのクエリ値をオーバーライドして、クエリパラメーター値を設定します。 |
UriBuilder | replaceQueryParams(MultiValueMap<java.lang.String,java.lang.String> params) 既存のすべてのクエリ値をオーバーライドして、クエリパラメーター値を設定します。 |
UriBuilder | scheme(java.lang.String scheme) URI テンプレート変数を含む URI スキームを設定します。このビルダーのスキームをクリアするには、 null にすることもできます。 |
UriBuilder | userInfo(java.lang.String userInfo) URI テンプレート変数を含む URI ユーザー情報を設定します。このビルダーのユーザー情報をクリアするには、 null にすることもできます。 |
UriBuilder scheme(@Nullable java.lang.String scheme)
null
にすることもできます。scheme
- URI スキーム UriBuilder userInfo(@Nullable java.lang.String userInfo)
null
にすることもできます。userInfo
- URI ユーザー情報 UriBuilder host(@Nullable java.lang.String host)
null
にすることもできます。host
- URI ホスト UriBuilder port(int port)
-1
を渡すと、このビルダーのポートがクリアされます。port
- URI ポート UriBuilder port(@Nullable java.lang.String port)
port(int)
を使用します。null
を渡すと、このビルダーのポートがクリアされます。port
- URI ポート UriBuilder path(java.lang.String path)
path
- URI パス UriBuilder replacePath(@Nullable java.lang.String path)
path
- URI パス、または空のパスの場合は null
UriBuilder pathSegment(java.lang.String... pathSegments) throws java.lang.IllegalArgumentException
path("/")
を使用して、末尾のスラッシュを確認します。pathSegments
- URI パスセグメント java.lang.IllegalArgumentException
UriBuilder query(java.lang.String query)
注意 : 予約文字の存在は、URI 文字列の正しい解析を妨げる可能性があります。たとえば、クエリパラメーターに '='
または '&'
文字が含まれている場合、クエリ文字列を明確に解析することはできません。正しい解析を可能にするために、そのような値を URI 変数に置き換える必要があります。
builder.query("filter={value}").uriString("hot&cold");
query
- クエリ文字列 UriBuilder replaceQuery(@Nullable java.lang.String query)
query
- クエリ文字列、またはすべてのクエリパラメーターを削除する null
UriBuilder queryParam(java.lang.String name, java.lang.Object... values)
?foo=bar
ではなく ?foo
になります)。name
- クエリパラメーター名 values
- クエリパラメーター値 UriBuilder queryParams(MultiValueMap<java.lang.String,java.lang.String> params)
params
- パラメーター UriBuilder replaceQueryParam(java.lang.String name, java.lang.Object... values)
name
- クエリパラメーター名 values
- クエリパラメーター値 UriBuilder replaceQueryParams(MultiValueMap<java.lang.String,java.lang.String> params)
params
- クエリパラメーター名 UriBuilder fragment(@Nullable java.lang.String fragment)
null
になる場合もあります。fragment
- URI フラグメント java.net.URI build(java.lang.Object... uriVariables)
URI
インスタンスを構築し、URI テンプレート変数を配列の値で置き換えます。uriVariables
- URI 変数のマップ java.net.URI build(java.util.Map<java.lang.String,?> uriVariables)
URI
インスタンスを作成し、URI テンプレート変数をマップの値で置き換えます。uriVariables
- URI 変数のマップ