インターフェース Link.Builder

方法の詳細

• link

  Link.Builder link(Link link)

  別のリンクを使用してビルダーを初期化します。基になる URI を設定し、すべてのパラメーターをコピーします。

  パラメーター:

  link - 初期化する他のリンク。

  戻り値:

  更新されたビルダー。

• link

  Link.Builder link(StringSE link)

  文字列として表される別のリンクを使用して Builder を初期化します。単純なパーサーを使用して、文字列表現をリンクに変換します。

   link ::= '<' uri 'gt;' (';' link-param)*
   link-param ::= name '=' quoted-string
   

  詳細については、RFC 5988 を参照してください。

  パラメーター:

  link - 文字列表現の他のリンク。

  戻り値:

  更新されたビルダー。

  例外:

  IllegalArgumentExceptionSE - URI の文字列表現が無効な場合。

• uri

  Link.Builder uri(URISE uri)

  構築中のリンクの基になる URI テンプレートを設定します。

  パラメーター:

  uri - リンクの基になる URI

  戻り値:

  更新されたビルダー。

• uri

  Link.Builder uri(StringSE uri)

  構築中のリンクの URI テンプレートを表す基になる文字列を設定します。

  パラメーター:

  uri - リンクの基になる URI。

  戻り値:

  更新されたビルダー。

  例外:

  IllegalArgumentExceptionSE - URI の文字列表現が無効な場合。

• baseUri

  Link.Builder baseUri(URISE uri)

  相対 URI を解決するためのベース URI を設定します。基になる URI がすでに絶対である場合、ベース URI は無視されます。

  パラメーター:

  uri - 相対リンクのベース URI。

  戻り値:

  更新されたビルダー。

  関連事項:

  • Link.fromPath(java.lang.String)
  • Link.fromResource(java.lang.Class)
  • Link.fromMethod(java.lang.Class, java.lang.String)

• baseUri

  Link.Builder baseUri(StringSE uri)

  ベース URI を相対 URI を解決するための文字列として設定します。基になる URI がすでに絶対である場合、ベース URI は無視されます。

  パラメーター:

  uri - 相対リンクのベース URI。

  戻り値:

  更新されたビルダー。

  例外:

  IllegalArgumentExceptionSE - URI の文字列表現が無効な場合。

  関連事項:

  • Link.fromPath(java.lang.String)
  • Link.fromResource(java.lang.Class)
  • Link.fromMethod(java.lang.Class, java.lang.String)

• uriBuilder

  Link.Builder uriBuilder(UriBuilder uriBuilder)

  構築中のリンクの URI テンプレートを表す基になる URI ビルダーを設定します。

  パラメーター:

  uriBuilder - 基盤となる URI ビルダー。

  戻り値:

  更新されたビルダー。

• rel

  Link.Builder rel(StringSE rel)

  リンク関係を設定するための便利なメソッド。RFC 5988 に従って、区切り文字として 1 つ以上の空白文字を使用することにより、複数の rel 値を指定できます。このメソッドを呼び出すことの効果は累積的です。リレーションは、単一のスペース文字を区切り文字として使用して追加されます。

  パラメーター:

  rel - リレーション名。

  戻り値:

  更新されたビルダー。

  例外:

  IllegalArgumentExceptionSE - 名前が null の場合。

• title

  Link.Builder title(StringSE title)

  このリンクに title を設定するための便利なメソッド。

  パラメーター:

  title - このリンクのタイトルパラメーター。

  戻り値:

  更新されたビルダー。

  例外:

  IllegalArgumentExceptionSE - タイトルが null の場合。

• type

  Link.Builder type(StringSE type)

  このリンクに type を設定するための便利なメソッド。

  パラメーター:

  type - このリンクの型パラメーター。

  戻り値:

  更新されたビルダー。

  例外:

  IllegalArgumentExceptionSE - 型が null の場合。

• param

  Link.Builder param(StringSE name, StringSE value)

  このリンクに任意のパラメーターを設定します。リンクパラメーターは RFC5988 で定義されているものであり、build(Object...) を呼び出すときに指定できる URI パラメーターと混同しないでください。

  パラメーター:

  name - パラメーターの名前。

  value - パラメーターに設定された値。

  戻り値:

  更新されたビルダー。

  例外:

  IllegalArgumentExceptionSE - 名前または値のいずれかが null の場合。

• build

  Link build(ObjectSE... values)

  提供された値を URI パラメーターとして使用して、このリンクの構築を完了します。ビルダーの状態は影響を受けません。このメソッドは、同じビルダーインスタンスで複数回呼び出される場合があります。

  パラメーター:

  values - 基礎となる URI を構築するために使用されるパラメーター。

  戻り値:

  新しく構築されたリンク。

  例外:

  IllegalArgumentExceptionSE - 指定された値のない URI テンプレートパラメーターがある場合、または値が null の場合。

  UriBuilderException - 基になる URI ビルダーの現在の状態に基づいて URI を構築できない場合。

• buildRelativized

  Link buildRelativized(URISE uri, ObjectSE... values)

  提供された値を URI パラメーターとして使用してこのリンクの構築を完了し、提供された URI に関して結果を相対化します。基になるリンクがすでに相対的であるか、絶対的であるが指定された URI とプレフィックスを共有していない場合、このメソッドは build(java.lang.Object[]) を呼び出すのと同じです。ベース URI は、baseUri(java.net.URI) を使用して相対リンクに設定できることに注意してください。ビルダーの状態は影響を受けません。このメソッドは、同じビルダーインスタンスで複数回呼び出される場合があります。

  パラメーター:

  uri - 相対化に使用される URI。

  values - 基礎となる URI を構築するために使用されるパラメーター。

  戻り値:

  新しく構築されたリンク。

  例外:

  IllegalArgumentExceptionSE - 指定された値のない URI テンプレートパラメーターがある場合、または値が null の場合。

  UriBuilderException - 基になる URI ビルダーの現在の状態に基づいて URI を構築できない場合。

  関連事項:

  • baseUri(java.lang.String)
  • baseUri(java.net.URI)