Link (Jakarta EE 8 Specification API)

java.lang.ObjectSE
- javax.ws.rs.core.Link

```
public abstract class Link
extends ObjectSE
```
ハイパーメディアリンクを表すクラス。ハイパーメディアリンクには、基になる URI 以外に追加のパラメーターが含まれる場合があります。rel や type などのパラメーターは、追加のメタデータを提供します。レスポンス内のリンクの後に、Invocation.Builder または WebTarget を作成できます。
メソッド toString() および valueOf(java.lang.String) を使用して、リンクをリンクヘッダー（RFC 5988）に直列化および逆直列化できます。
導入:
2.0
作成者:
Marek Potociar, Santiago Pericas-Geertsen
関連事項:
Client.invocation(javax.ws.rs.core.Link), Client.target(javax.ws.rs.core.Link), Response.getLink(java.lang.String)

ネストされたクラスのサマリー

ネストされたクラス
修飾子と型	クラスと説明
`static interface`	`Link.Builder` ハイパーメディアリンクのビルダークラス。
`static class`	`Link.JaxbAdapter` `Link` 型を JAXB によってマーシャリングおよびアンマーシャリングできる値にマップする JAXB `XmlAdapter`SE の実装。
`static class`	`Link.JaxbLink` JAXB によってマーシャリングおよびアンマーシャリングできる `Link` の値型。

フィールドサマリー

フィールド
修飾子と型	フィールドと説明
`static StringSE`	`REL` RFC5988 の Rellinkparam。
`static StringSE`	`TITLE` RFC5988 のタイトルリンクパラメーター。
`static StringSE`	`TYPE` RFC5988 の linkparam と入力します。

コンストラクターのサマリー
コンストラクター
コンストラクターと説明
Link()

コンストラクター
コンストラクターと説明
`Link()`

方法の概要

すべてのメソッド静的メソッドインスタンスメソッド抽象メソッド具象メソッド
修飾子と型	メソッドと説明
`static Link.Builder`	`fromLink(Link link)` 別のリンクから初期化された新しいビルダーインスタンスを作成します。
`static Link.Builder`	`fromMethod(ClassSE<?> resource, StringSE method)` リソースからリンクを構築するための便利なメソッド。
`static Link.Builder`	`fromPath(StringSE path)` パスからリンクを構築するための便利なメソッド。
`static Link.Builder`	`fromResource(ClassSE<?> resource)` リソースからリンクを構築するための便利なメソッド。
`static Link.Builder`	`fromUri(StringSE uri)` 文字列として表される既存の URI から初期化された新しいビルダーインスタンスを作成します。
`static Link.Builder`	`fromUri(URISE uri)` 既存の URI から初期化された新しいビルダーインスタンスを作成します。
`static Link.Builder`	`fromUriBuilder(UriBuilder uriBuilder)` URI ビルダーから初期化された新しいビルダーインスタンスを作成します。
`abstract MapSE<StringSE, StringSE>`	`getParams()` このリンクで定義されているすべてのリンクパラメーターを含む不変のマップを返します。
`abstract StringSE`	`getRel()` リンク `rel` パラメーターに関連付けられた値を返します。このパラメーターが指定されていない場合は `null` を返します。
`abstract ListSE<StringSE>`	`getRels()` リンク `rel` パラメーターに関連付けられた値を文字列のリストとして返すか、`rel` が定義されていない場合は空のリストを返します。
`abstract StringSE`	`getTitle()` リンク `title` パラメーターに関連付けられた値を返します。このパラメーターが指定されていない場合は `null` を返します。
`abstract StringSE`	`getType()` リンク `type` パラメーターに関連付けられた値を返します。このパラメーターが指定されていない場合は `null` を返します。
`abstract URISE`	`getUri()` このリンクに関連付けられている基になる URI を返します。
`abstract UriBuilder`	`getUriBuilder()` このリンクの基になる URI で初期化された `UriBuilder` を返すコンビニエンスメソッド。
`abstract StringSE`	`toString()` 文字列表現をリンクヘッダーとして返します（RFC5988）。
`static Link`	`valueOf(StringSE value)` リンクヘッダー文字列表現をリンクに変換するための単純なパーサー。

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

- フィールドの詳細
  - TITLE
```
public static final StringSE TITLE
```
    RFC5988 のタイトルリンクパラメーター。
    関連事項:
    定数フィールド値
  - REL
```
public static final StringSE REL
```
    RFC5988 の Rellinkparam。
    関連事項:
    定数フィールド値
  - TYPE
```
public static final StringSE TYPE
```
    RFC5988 の linkparam と入力します。
    関連事項:
    定数フィールド値
- コンストラクターの詳細
  - Link
```
public 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()
```
    文字列表現をリンクヘッダーとして返します（RFC5988）。すべてのリンクパラメーターは、link-param="value" として直列化されます。ここで、value は引用符で囲まれた文字列です。例: ; title=" 従業員 "; rel=" マネージャーの友達 "
    オーバーライド:
    クラス ObjectSE の toStringSE
    戻り値:
    このリンクの文字列リンクヘッダー表現。
  - valueOf
```
public static Link valueOf(StringSE value)
```
    リンクヘッダー文字列表現をリンクに変換するための単純なパーサー。
```
 link ::= '<' uri '>' (';' 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()

クラス Link

ネストされたクラスのサマリー

フィールドサマリー

コンストラクターのサマリー

方法の概要

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

フィールドの詳細

TITLE

REL

TYPE

コンストラクターの詳細

Link

メソッドの詳細

getUri

getUriBuilder

getRel

getRels

getTitle

getType

getParams

toString

valueOf

fromUri

fromUri

fromUriBuilder

fromLink

fromPath

fromResource

fromMethod