クラス Link

メソッドの詳細

• getUri

  public abstract URISE getUri()

  このリンクに関連付けられている基になる URI を返します。

  戻り値:

  基になる URI。

• getUriBuilder

  public abstract UriBuilder getUriBuilder()

  このリンクの基になる URI で初期化された UriBuilder を返すコンビニエンスメソッド。

  戻り値:

  基礎となる URI を使用して初期化された UriBuilder。

• getRel

  public abstract StringSE getRel()

  リンク rel パラメーターに関連付けられた値を返します。このパラメーターが指定されていない場合は null を返します。

  戻り値:

  文字列または null としての関係型。

• getRels

  public abstract ListSE<StringSE> getRels()

  リンク rel パラメーターに関連付けられた値を文字列のリストとして返すか、rel が定義されていない場合は空のリストを返します。

  戻り値:

  文字列のリストまたは空のリストとしての関係型。

• getTitle

  public abstract StringSE getTitle()

  リンク title パラメーターに関連付けられた値を返します。このパラメーターが指定されていない場合は null を返します。

  戻り値:

  タイトルパラメーターまたは null の値。

• getType

  public abstract StringSE getType()

  リンク type パラメーターに関連付けられた値を返します。このパラメーターが指定されていない場合は null を返します。

  戻り値:

  型パラメーターまたは null の値。

• getParams

  public abstract MapSE<StringSE,StringSE> getParams()

  このリンクで定義されているすべてのリンクパラメーターを含む不変のマップを返します。定義されている場合、このマップには rel、title、type のエントリが含まれます。

  戻り値:

  リンクパラメーターの不変マップ。

• toString

  public abstract StringSE toString()

  リンクヘッダーとして文字列表現を返します (RFC 5988)。すべてのリンクパラメーターは、link-param="value" として直列化されます。ここで、value は引用符で囲まれた文字列です。例: <http://foo.bar/employee/john>; title="employee" ; rel="manager friend"

  オーバーライド:

  クラス ObjectSE の toString 

  戻り値:

  このリンクの文字列リンクヘッダー表現。

• valueOf

  public static Link valueOf(StringSE value)

  リンクヘッダー文字列表現をリンクに変換するための単純なパーサー。

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

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

  パラメーター:

  value - 文字列表現。

  戻り値:

  新しく解析されたリンク。

  例外:

  IllegalArgumentExceptionSE - 構文エラーが見つかった場合。

  関連事項:

  • Link.Builder.link(java.lang.String)

• fromUri

  public static Link.Builder fromUri(URISE uri)

  既存の URI から初期化された新しいビルダーインスタンスを作成します。

  パラメーター:

  uri - ビルダーを初期化するために使用される URI。

  戻り値:

  新しいビルダー。

  例外:

  IllegalArgumentExceptionSE - uri が null の場合。

• fromUri

  public static Link.Builder fromUri(StringSE uri)

  文字列として表される既存の URI から初期化された新しいビルダーインスタンスを作成します。

  パラメーター:

  uri - ビルダーを初期化するために使用される URI。

  戻り値:

  新しいビルダー。

  例外:

  IllegalArgumentExceptionSE - uri が null の場合。

• fromUriBuilder

  public static Link.Builder fromUriBuilder(UriBuilder uriBuilder)

  URI ビルダーから初期化された新しいビルダーインスタンスを作成します。

  パラメーター:

  uriBuilder - URI ビルダーのインスタンス。

  戻り値:

  新しいビルダー。

• fromLink

  public static Link.Builder fromLink(Link link)

  別のリンクから初期化された新しいビルダーインスタンスを作成します。

  パラメーター:

  link - 初期化に使用される他のリンク。

  戻り値:

  新しいビルダー。

• fromPath

  public static Link.Builder fromPath(StringSE path)

  パスからリンクを構築するための便利なメソッド。fromUriBuilder(UriBuilder.fromPath(path)) と同等です。

  パラメーター:

  path - リンクの初期化に使用される URI パスには、URI テンプレートパラメーターが含まれる場合があります。

  戻り値:

  新しい Link.Builder。

  例外:

  IllegalArgumentExceptionSE - パスが null の場合。

• fromResource

  public static Link.Builder fromResource(ClassSE<?> resource)

  リソースからリンクを構築するための便利なメソッド。Link.fromUriBuilder({@link UriBuilder#fromResource UriBuilder.fromResource(resource)}) と同等です。このメソッドによって返される Link.Builder インスタンスに渡されるリンク URI は相対的であることに注意してください。リンクを絶対として構築する場合は、新しいリンクインスタンスを構築する前に、ビルダーで base URI を指定する必要があります。例: サーバー側では、通常、UriInfo.getBaseUri() を使用して、このメソッドを使用して作成されたリンクのベース URI を定義できます。

  パラメーター:

  resource - Path 値がビルダーの初期化に使用されるルートリソース。

  戻り値:

  新しい link builder インスタンス。

  例外:

  IllegalArgumentExceptionSE - リソースに Path アノテーションが付けられていない場合、またはリソースが null である場合。

  関連事項:

  • UriInfo.getBaseUri()

• fromMethod

  public static Link.Builder fromMethod(ClassSE<?> resource, StringSE method)

  リソースからリンクを構築するための便利なメソッド。Link.fromUriBuilder({@link UriBuilder#fromMethod(Class, String) UriBuilder.fromMethod(resource, method)}) と同等です。このメソッドによって返される Link.Builder インスタンスに渡されるリンク URI は相対的であることに注意してください。リンクを絶対として構築する場合は、新しいリンクインスタンスを構築する前に、ビルダーで base URI を指定する必要があります。例: サーバー側では、通常、UriInfo.getBaseUri() を使用して、このメソッドを使用して作成されたリンクのベース URI を定義できます。

  パラメーター:

  resource - メソッドを含むリソース。

  method - 追加するパスを取得するために Path 値が使用されるメソッドの名前。

  戻り値:

  更新された Link.Builder。

  例外:

  IllegalArgumentExceptionSE - リソースまたはメソッドが null である場合、または Path でアノテーションされたメソッドのバリアントが 1 つ以上ある場合。

  関連事項:

  • UriInfo.getBaseUri()