Modifier and Type	Class and Description
public static interface	Link.Builder Builder class for hypermedia links.
public static class	Link.JaxbAdapter Deprecated An implementation of JAXB `jakarta.xml.bind.annotation.adapters.XmlAdapter` that maps the JAX-RS `jakarta.ws.rs.core.Link` type to a value that can be marshalled and unmarshalled by JAXB.
public static class	Link.JaxbLink Deprecated Value type for `jakarta.ws.rs.core.Link` that can be marshalled and unmarshalled by JAXB.

Modifier and Type	Field and Description
public static final String	REL Rel link param from RFC 5988.
public static final String	TITLE Title link param from RFC 5988.
public static final String	TYPE Type link param from RFC 5988.

Access	Constructor and Description
public	Link()

Method Summary

Modifier and Type	Method and Description
public static Link.Builder	Returns: a new builder. fromLink(final Link other link used for initialization. link) Create a new builder instance initialized from another link.
public static Link.Builder	Returns: the updated Link.Builder. fromMethod(final Class<?> the resource containing the method. resource, final String the name of the method whose `jakarta.ws.rs.Path` value will be used to obtain the path to append. method) Convenience method to build a link from a resource.
public static Link.Builder	Returns: a new Link.Builder. fromPath(final String a URI path that will be used to initialize the Link, may contain URI template parameters. path) Convenience method to build a link from a path.
public static Link.Builder	Returns: a new `link builder` instance. fromResource(final Class<?> a root resource whose `jakarta.ws.rs.Path` value will be used to initialize the builder. resource) Convenience method to build a link from a resource.
public static Link.Builder	Returns: a new builder. fromUri(final URI a URI that will be used to initialize the builder. uri) Create a new builder instance initialized from an existing URI.
public static Link.Builder	Returns: a new builder. fromUri(final String a URI that will be used to initialize the builder. uri) Create a new builder instance initialized from an existing URI represented as a string.
public static Link.Builder	Returns: a new builder. fromUriBuilder(final UriBuilder instance of URI builder. uriBuilder) Create a new builder instance initialized from a URI builder.
public abstract Map<String, String>	Returns: immutable map of link parameters. getParams() Returns an immutable map that includes all the link parameters defined on this link.
public abstract String	Returns: relation types as string or `null`. getRel() Returns the value associated with the link `rel` param, or `null` if this param is not specified.
public abstract List<String>	Returns: relation types as list of strings or empty list. getRels() Returns the value associated with the link `rel` param as a list of strings or the empty list if `rel` is not defined.
public abstract String	Returns: value of title parameter or `null`. getTitle() Returns the value associated with the link `title` param, or `null` if this param is not specified.
public abstract String	Returns: value of type parameter or `null`. getType() Returns the value associated with the link `type` param, or `null` if this param is not specified.
public abstract URI	Returns: underlying URI. getUri() Returns the underlying URI associated with this link.
public abstract UriBuilder	Returns: UriBuilder initialized using underlying URI. getUriBuilder() Convenience method that returns a `jakarta.ws.rs.core.UriBuilder` initialized with this link's underlying URI.
public abstract String	Returns: string link header representation for this link. toString() Overrides java.lang.Object.toString. Returns a string representation as a link header (RFC 5988).
public static Link	Returns: newly parsed link. valueOf(final String String representation. value) Simple parser to convert link header string representations into a link.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll wait wait wait

Field Detail

REL	back to summary
public static final String REL Rel link param from RFC 5988.

TITLE	back to summary
public static final String TITLE Title link param from RFC 5988.

TYPE	back to summary
public static final String TYPE Type link param from RFC 5988.

Constructor Detail

Link	back to summary
public Link()

Method Detail

fromLink	back to summary
public static Link.Builder fromLink(final Link link) Create a new builder instance initialized from another link. Parameters link:Link other link used for initialization. Returns:Link.Builder a new builder.

fromLink

back to summary

public static Link.Builder fromLink(final Link link)

Create a new builder instance initialized from another link.

Parameters

link:Link: other link used for initialization.

Returns:Link.Builder

a new builder.

fromMethod back to summary

fromMethod	back to summary
public static Link.Builder fromMethod(final Class<?> resource, final String method) Convenience method to build a link from a resource. Equivalent to `Link.fromUriBuilder({@link UriBuilder#fromMethod(Class, String) UriBuilder.fromMethod(resource, method)})`. Note that the link URI passed to the `Link.Builder` instance returned by this method is relative. Should the link be built as absolute, a `base URI` has to be specified in the builder prior to building the new link instance. For example, on a server side a `UriInfo#getBaseUri()` may be typically used to define the base URI of a link created using this method. Parameters resource:Class<?> the resource containing the method. method:String the name of the method whose `jakarta.ws.rs.Path` value will be used to obtain the path to append. Returns:Link.Builder the updated Link.Builder. Exceptions IllegalArgumentException: if resource or method is `null`, or there is more than or less than one variant of the method annotated with `jakarta.ws.rs.Path`. See Also `UriInfo#getBaseUri()`

public static Link.Builder fromMethod(final Class<?> resource, final String method)

Convenience method to build a link from a resource. Equivalent to Link.fromUriBuilder({@link UriBuilder#fromMethod(Class, String) UriBuilder.fromMethod(resource, method)}). Note that the link URI passed to the Link.Builder instance returned by this method is relative. Should the link be built as absolute, a base URI has to be specified in the builder prior to building the new link instance. For example, on a server side a UriInfo#getBaseUri() may be typically used to define the base URI of a link created using this method.

Parameters

resource:Class<?>: the resource containing the method.
method:String: the name of the method whose jakarta.ws.rs.Path value will be used to obtain the path to append.

Returns:Link.Builder

the updated Link.Builder.

Exceptions

IllegalArgumentException:: if resource or method is null, or there is more than or less than one variant of the method annotated with jakarta.ws.rs.Path.

See Also

UriInfo#getBaseUri()

fromPath back to summary

fromPath	back to summary
public static Link.Builder fromPath(final String path) Convenience method to build a link from a path. Equivalent to `fromUriBuilder(UriBuilder.fromPath(path))`. Parameters path:String a URI path that will be used to initialize the Link, may contain URI template parameters. Returns:Link.Builder a new Link.Builder. Exceptions IllegalArgumentException: if path is `null`.

public static Link.Builder fromPath(final String path)

Convenience method to build a link from a path. Equivalent to fromUriBuilder(UriBuilder.fromPath(path)).

Parameters

path:String: a URI path that will be used to initialize the Link, may contain URI template parameters.

Returns:Link.Builder

a new Link.Builder.

Exceptions

IllegalArgumentException:: if path is null.

fromResource back to summary

fromResource	back to summary
public static Link.Builder fromResource(final Class<?> resource) Convenience method to build a link from a resource. Equivalent to `Link.fromUriBuilder({@link UriBuilder#fromResource UriBuilder.fromResource(resource)})`. Note that the link URI passed to the `Link.Builder` instance returned by this method is relative. Should the link be built as absolute, a `base URI` has to be specified in the builder prior to building the new link instance. For example, on a server side a `UriInfo#getBaseUri()` may be typically used to define the base URI of a link created using this method. Parameters resource:Class<?> a root resource whose `jakarta.ws.rs.Path` value will be used to initialize the builder. Returns:Link.Builder a new `link builder` instance. Exceptions IllegalArgumentException: if resource is not annotated with `jakarta.ws.rs.Path` or resource is `null`. See Also `UriInfo#getBaseUri()`

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

Convenience method to build a link from a resource. Equivalent to Link.fromUriBuilder({@link UriBuilder#fromResource UriBuilder.fromResource(resource)}). Note that the link URI passed to the Link.Builder instance returned by this method is relative. Should the link be built as absolute, a base URI has to be specified in the builder prior to building the new link instance. For example, on a server side a UriInfo#getBaseUri() may be typically used to define the base URI of a link created using this method.

Parameters

resource:Class<?>: a root resource whose jakarta.ws.rs.Path value will be used to initialize the builder.

Returns:Link.Builder

a new link builder instance.

Exceptions

IllegalArgumentException:: if resource is not annotated with jakarta.ws.rs.Path or resource is null.

See Also

UriInfo#getBaseUri()

fromUri back to summary

fromUri	back to summary
public static Link.Builder fromUri(final URI uri) Create a new builder instance initialized from an existing URI. Parameters uri:URI a URI that will be used to initialize the builder. Returns:Link.Builder a new builder. Exceptions IllegalArgumentException: if uri is `null`.

public static Link.Builder fromUri(final URI uri)

Create a new builder instance initialized from an existing URI.

Parameters

uri:URI: a URI that will be used to initialize the builder.

Returns:Link.Builder

a new builder.

Exceptions

IllegalArgumentException:: if uri is null.

fromUri back to summary

fromUri	back to summary
public static Link.Builder fromUri(final String uri) Create a new builder instance initialized from an existing URI represented as a string. Parameters uri:String a URI that will be used to initialize the builder. Returns:Link.Builder a new builder. Exceptions IllegalArgumentException: if uri is `null`.

public static Link.Builder fromUri(final String uri)

Create a new builder instance initialized from an existing URI represented as a string.

Parameters

uri:String: a URI that will be used to initialize the builder.

Returns:Link.Builder

a new builder.

Exceptions

IllegalArgumentException:: if uri is null.

fromUriBuilder	back to summary
public static Link.Builder fromUriBuilder(final UriBuilder uriBuilder) Create a new builder instance initialized from a URI builder. Parameters uriBuilder:UriBuilder instance of URI builder. Returns:Link.Builder a new builder.

fromUriBuilder

back to summary

public static Link.Builder fromUriBuilder(final UriBuilder uriBuilder)

Create a new builder instance initialized from a URI builder.

Parameters

uriBuilder:UriBuilder: instance of URI builder.

Returns:Link.Builder

a new builder.

getParams back to summary

getParams	back to summary
public abstract Map<String, String> getParams() Returns an immutable map that includes all the link parameters defined on this link. If defined, this map will include entries for `rel`, `title` and `type`. Returns:Map<String, String> immutable map of link parameters.

public abstract Map<String, String> getParams()

Returns an immutable map that includes all the link parameters defined on this link. If defined, this map will include entries for rel, title and type.

Returns:Map<String, String>: immutable map of link parameters.

getRel back to summary

getRel	back to summary
public abstract String getRel() Returns the value associated with the link `rel` param, or `null` if this param is not specified. Returns:String relation types as string or `null`.

public abstract String getRel()

Returns the value associated with the link rel param, or null if this param is not specified.

Returns:String: relation types as string or null.

getRels back to summary

getRels	back to summary
public abstract List<String> getRels() Returns the value associated with the link `rel` param as a list of strings or the empty list if `rel` is not defined. Returns:List<String> relation types as list of strings or empty list.

public abstract List<String> getRels()

Returns the value associated with the link rel param as a list of strings or the empty list if rel is not defined.

Returns:List<String>: relation types as list of strings or empty list.

getTitle back to summary

getTitle	back to summary
public abstract String getTitle() Returns the value associated with the link `title` param, or `null` if this param is not specified. Returns:String value of title parameter or `null`.

public abstract String getTitle()

Returns the value associated with the link title param, or null if this param is not specified.

Returns:String: value of title parameter or null.

getType back to summary

getType	back to summary
public abstract String getType() Returns the value associated with the link `type` param, or `null` if this param is not specified. Returns:String value of type parameter or `null`.

public abstract String getType()

Returns the value associated with the link type param, or null if this param is not specified.

Returns:String: value of type parameter or null.

getUri	back to summary
public abstract URI getUri() Returns the underlying URI associated with this link. Returns:URI underlying URI.

getUri

back to summary

public abstract URI getUri()

Returns the underlying URI associated with this link.

Returns:URI: underlying URI.

getUriBuilder back to summary

getUriBuilder	back to summary
public abstract UriBuilder getUriBuilder() Convenience method that returns a `jakarta.ws.rs.core.UriBuilder` initialized with this link's underlying URI. Returns:UriBuilder UriBuilder initialized using underlying URI.

public abstract UriBuilder getUriBuilder()

Convenience method that returns a jakarta.ws.rs.core.UriBuilder initialized with this link's underlying URI.

Returns:UriBuilder: UriBuilder initialized using underlying URI.

toString	back to summary
public abstract String toString() Overrides java.lang.Object.toString. Returns a string representation as a link header (RFC 5988). All link params are serialized as link-param="value" where value is a quoted-string. For example, <http://foo.bar/employee/john>; title="employee"; rel="manager friend" Returns:String string link header representation for this link. Annotations @Override

toString

back to summary

public abstract String toString()

Overrides java.lang.Object.toString.

Returns a string representation as a link header (RFC 5988). All link params are serialized as link-param="value" where value is a quoted-string. For example, <http://foo.bar/employee/john>; title="employee"; rel="manager friend"

Returns:String

string link header representation for this link.

Annotations

@Override

valueOf back to summary

valueOf	back to summary
public static Link valueOf(final String value) Simple parser to convert link header string representations into a link. link ::= '<' uri 'gt;' (';' link-param)* link-param ::= name '=' quoted-string See RFC 5988 for more information. Parameters value:String String representation. Returns:Link newly parsed link. Exceptions IllegalArgumentException: if a syntax error is found. See Also `Link.Builder#link(java.lang.String)`

public static Link valueOf(final String value)

Simple parser to convert link header string representations into a link.

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

See RFC 5988 for more information.

Parameters

value:String: String representation.

Returns:Link

newly parsed link.

Exceptions

IllegalArgumentException:: if a syntax error is found.

See Also

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

jakarta.ws.rs.core back to summary

public Interface Link.Builder

Builder class for hypermedia links.

Since: 2.0
See Also: Link

Method Summary

Modifier and Type	Method and Description
public Link.Builder	Returns: the updated builder. baseUri(URI base URI for relative links. uri) Set the base URI for resolution of relative URIs.
public Link.Builder	Returns: the updated builder. baseUri(String base URI for relative links. uri) Set the base URI as a string for resolution of relative URIs.
public Link	Returns: newly built link. build(Object... parameters used to build underlying URI. values) Finish building this link using the supplied values as URI parameters.
public Link	Returns: newly built link. buildRelativized(URI URI used for relativization. uri, Object... parameters used to build underlying URI. values) Finish building this link using the supplied values as URI parameters and relativize the result with respect to the supplied URI.
public Link.Builder	Returns: the updated builder. link(Link other link from which to initialize. link) Initialize builder using another link.
public Link.Builder	Returns: the updated builder. link(String other link in string representation. link) Initialize builder using another link represented as a string.
public Link.Builder	Returns: the updated builder. param(String the name of the parameter. name, String the value set for the parameter. value) Set an arbitrary parameter on this link.
public Link.Builder	Returns: the updated builder. rel(String relation name. rel) Convenience method to set a link relation.
public Link.Builder	Returns: the updated builder. title(String title parameter of this link. title) Convenience method to set a `title` on this link.
public Link.Builder	Returns: the updated builder. type(String type parameter of this link. type) Convenience method to set a `type` on this link.
public Link.Builder	Returns: the updated builder. uri(URI underlying URI for link uri) Set underlying URI template for the link being constructed.
public Link.Builder	Returns: the updated builder. uri(String underlying URI for link. uri) Set underlying string representing URI template for the link being constructed.
public Link.Builder	Returns: the updated builder. uriBuilder(UriBuilder underlying URI builder. uriBuilder) Set underlying URI builder representing the URI template for the link being constructed.

Method Detail

baseUri back to summary

baseUri	back to summary
public Link.Builder baseUri(URI uri) Set the base URI for resolution of relative URIs. If the underlying URI is already absolute, the base URI is ignored. Parameters uri:URI base URI for relative links. Returns:Link.Builder the updated builder. See Also `Link#fromPath(java.lang.String)`, `Link#fromResource(java.lang.Class)`, `Link#fromMethod(java.lang.Class, java.lang.String)`

public Link.Builder baseUri(URI uri)

Set the base URI for resolution of relative URIs. If the underlying URI is already absolute, the base URI is ignored.

Parameters

uri:URI: base URI for relative links.

Returns:Link.Builder

the updated builder.

baseUri back to summary

baseUri	back to summary
public Link.Builder baseUri(String uri) Set the base URI as a string for resolution of relative URIs. If the underlying URI is already absolute, the base URI is ignored. Parameters uri:String base URI for relative links. Returns:Link.Builder the updated builder. Exceptions IllegalArgumentException: if string representation of URI is invalid. See Also `Link#fromPath(java.lang.String)`, `Link#fromResource(java.lang.Class)`, `Link#fromMethod(java.lang.Class, java.lang.String)`

public Link.Builder baseUri(String uri)

Set the base URI as a string for resolution of relative URIs. If the underlying URI is already absolute, the base URI is ignored.

Parameters

uri:String: base URI for relative links.

Returns:Link.Builder

the updated builder.

Exceptions

IllegalArgumentException:: if string representation of URI is invalid.

build back to summary

build	back to summary
public Link build(Object... values) Finish building this link using the supplied values as URI parameters. The state of the builder is unaffected; this method may be called multiple times on the same builder instance. Parameters values:Object[] parameters used to build underlying URI. Returns:Link newly built link. Exceptions IllegalArgumentException: if there are any URI template parameters without a supplied value, or if a value is `null`. UriBuilderException: if a URI cannot be constructed based on the current state of the underlying URI builder.

public Link build(Object... values)

Finish building this link using the supplied values as URI parameters. The state of the builder is unaffected; this method may be called multiple times on the same builder instance.

Parameters

values:Object[]: parameters used to build underlying URI.

Returns:Link

newly built link.

Exceptions

IllegalArgumentException:: if there are any URI template parameters without a supplied value, or if a value is null.
UriBuilderException:: if a URI cannot be constructed based on the current state of the underlying URI builder.

buildRelativized back to summary

buildRelativized	back to summary
public Link buildRelativized(URI uri, Object... values) Finish building this link using the supplied values as URI parameters and relativize the result with respect to the supplied URI. If the underlying link is already relative or if it is absolute but does not share a prefix with the supplied URI, this method is equivalent to calling `Link.Builder#build(java.lang.Object[])`. Note that a base URI can be set on a relative link using `Link.Builder#baseUri(java.net.URI)`. The state of the builder is unaffected; this method may be called multiple times on the same builder instance. Parameters uri:URI URI used for relativization. values:Object[] parameters used to build underlying URI. Returns:Link newly built link. Exceptions IllegalArgumentException: if there are any URI template parameters without a supplied value, or if a value is `null`. UriBuilderException: if a URI cannot be constructed based on the current state of the underlying URI builder. See Also `baseUri(java.lang.String)`, `baseUri(java.net.URI)`

public Link buildRelativized(URI uri, Object... values)

Finish building this link using the supplied values as URI parameters and relativize the result with respect to the supplied URI. If the underlying link is already relative or if it is absolute but does not share a prefix with the supplied URI, this method is equivalent to calling Link.Builder#build(java.lang.Object[]). Note that a base URI can be set on a relative link using Link.Builder#baseUri(java.net.URI). The state of the builder is unaffected; this method may be called multiple times on the same builder instance.

Parameters

uri:URI: URI used for relativization.
values:Object[]: parameters used to build underlying URI.

Returns:Link

newly built link.

Exceptions

IllegalArgumentException:: if there are any URI template parameters without a supplied value, or if a value is null.
UriBuilderException:: if a URI cannot be constructed based on the current state of the underlying URI builder.

link	back to summary
public Link.Builder link(Link link) Initialize builder using another link. Sets underlying URI and copies all parameters. Parameters link:Link other link from which to initialize. Returns:Link.Builder the updated builder.

link

back to summary

public Link.Builder link(Link link)

Initialize builder using another link. Sets underlying URI and copies all parameters.

Parameters

link:Link: other link from which to initialize.

Returns:Link.Builder

the updated builder.

link	back to summary
public Link.Builder link(String link) Initialize builder using another link represented as a string. Uses simple parser to convert string representation into a link. link ::= '<' uri 'gt;' (';' link-param)* link-param ::= name '=' quoted-string See RFC 5988 for more information. Parameters link:String other link in string representation. Returns:Link.Builder the updated builder. Exceptions IllegalArgumentException: if string representation of URI is invalid.

link

back to summary

public Link.Builder link(String link)

Initialize builder using another link represented as a string. Uses simple parser to convert string representation into a link.

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

See RFC 5988 for more information.

Parameters

link:String: other link in string representation.

Returns:Link.Builder

the updated builder.

Exceptions

IllegalArgumentException:: if string representation of URI is invalid.

param back to summary

param	back to summary
public Link.Builder param(String name, String value) Set an arbitrary parameter on this link. Note that link parameters are those defined in RFC 5988 and should not be confused with URI parameters which can be specified when calling `build(Object...)`. Parameters name:String the name of the parameter. value:String the value set for the parameter. Returns:Link.Builder the updated builder. Exceptions IllegalArgumentException: if either the name or value are `null`.

public Link.Builder param(String name, String value)

Set an arbitrary parameter on this link. Note that link parameters are those defined in RFC 5988 and should not be confused with URI parameters which can be specified when calling build(Object...).

Parameters

name:String: the name of the parameter.
value:String: the value set for the parameter.

Returns:Link.Builder

the updated builder.

Exceptions

IllegalArgumentException:: if either the name or value are null.

rel back to summary

rel	back to summary
public Link.Builder rel(String rel) Convenience method to set a link relation. More than one `rel` value can be specified by using one or more whitespace characters as delimiters according to RFC 5988. The effect of calling this method is cumulative; relations are appended using a single space character as separator. Parameters rel:String relation name. Returns:Link.Builder the updated builder. Exceptions IllegalArgumentException: if the name is `null`.

public Link.Builder rel(String rel)

Convenience method to set a link relation. More than one rel value can be specified by using one or more whitespace characters as delimiters according to RFC 5988. The effect of calling this method is cumulative; relations are appended using a single space character as separator.

Parameters

rel:String: relation name.

Returns:Link.Builder

the updated builder.

Exceptions

IllegalArgumentException:: if the name is null.

title back to summary

title	back to summary
public Link.Builder title(String title) Convenience method to set a `title` on this link. Parameters title:String title parameter of this link. Returns:Link.Builder the updated builder. Exceptions IllegalArgumentException: if the title is `null`.

public Link.Builder title(String title)

Convenience method to set a title on this link.

Parameters

title:String: title parameter of this link.

Returns:Link.Builder

the updated builder.

Exceptions

IllegalArgumentException:: if the title is null.

type back to summary

type	back to summary
public Link.Builder type(String type) Convenience method to set a `type` on this link. Parameters type:String type parameter of this link. Returns:Link.Builder the updated builder. Exceptions IllegalArgumentException: if the type is `null`.

public Link.Builder type(String type)

Convenience method to set a type on this link.

Parameters

type:String: type parameter of this link.

Returns:Link.Builder

the updated builder.

Exceptions

IllegalArgumentException:: if the type is null.

uri	back to summary
public Link.Builder uri(URI uri) Set underlying URI template for the link being constructed. Parameters uri:URI underlying URI for link Returns:Link.Builder the updated builder.

uri

back to summary

public Link.Builder uri(URI uri)

Set underlying URI template for the link being constructed.

Parameters

uri:URI: underlying URI for link

Returns:Link.Builder

the updated builder.

uri	back to summary
public Link.Builder uri(String uri) Set underlying string representing URI template for the link being constructed. Parameters uri:String underlying URI for link. Returns:Link.Builder the updated builder. Exceptions IllegalArgumentException: if string representation of URI is invalid.

uri

back to summary

public Link.Builder uri(String uri)

Set underlying string representing URI template for the link being constructed.

Parameters

uri:String: underlying URI for link.

Returns:Link.Builder

the updated builder.

Exceptions

IllegalArgumentException:: if string representation of URI is invalid.

uriBuilder	back to summary
public Link.Builder uriBuilder(UriBuilder uriBuilder) Set underlying URI builder representing the URI template for the link being constructed. Parameters uriBuilder:UriBuilder underlying URI builder. Returns:Link.Builder the updated builder.

uriBuilder

back to summary

public Link.Builder uriBuilder(UriBuilder uriBuilder)

Set underlying URI builder representing the URI template for the link being constructed.

Parameters

uriBuilder:UriBuilder: underlying URI builder.

Returns:Link.Builder

the updated builder.

jakarta.ws.rs.core back to summary

public Class Link.JaxbAdapter

Class Inheritance

extends XmlAdapter<Link.JaxbLink, Link>

java.lang.Object
jakarta.xml.bind.annotation.adapters.XmlAdapter
jakarta.ws.rs.core.Link.JaxbAdapter

Annotations

@Deprecated

Deprecated

An implementation of JAXB jakarta.xml.bind.annotation.adapters.XmlAdapter that maps the JAX-RS jakarta.ws.rs.core.Link type to a value that can be marshalled and unmarshalled by JAXB. The following example shows how to use this adapter on a JAXB bean class:

@XmlRootElement
public class MyModel {

  private Link link;

  @XmlElement(name="link")
  @XmlJavaTypeAdapter(JaxbAdapter.class)
  public Link getLink() {
    return link;
  }
  ...
}

Note that usage of this class requires the Jakarta XML Binding API and an implementation. The Jakarta RESTful Web Services implementation is not required to provide these dependencies.

Since: 2.0
See Also: jakarta.ws.rs.core.Link.JaxbLink

Constructor Summary

Access	Constructor and Description
public	JaxbAdapter()

Method Summary

Modifier and Type	Method and Description
public Link.JaxbLink	Returns: mapped instance of type `JaxbLink`. marshal(final Link instance of type `Link`. v) Implements abstract jakarta.xml.bind.annotation.adapters.XmlAdapter.marshal. Deprecated as a consequence of `Link.JaxbLink` being deprecated. Convert a `Link` into a `JaxbLink`.
public Link	Returns: mapped instance of type `JaxbLink` unmarshal(final Link.JaxbLink instance of type `JaxbLink`. v) Implements abstract jakarta.xml.bind.annotation.adapters.XmlAdapter.unmarshal. Deprecated as a consequence of `Link.JaxbLink` being deprecated. Convert a `JaxbLink` into a `Link`.

Constructor Detail

JaxbAdapter	back to summary
public JaxbAdapter()

Method Detail

marshal back to summary

marshal	back to summary
public Link.JaxbLink marshal(final Link v) Implements abstract jakarta.xml.bind.annotation.adapters.XmlAdapter.marshal. Deprecated as a consequence of `Link.JaxbLink` being deprecated. See corresponding docs for further information. Convert a `Link` into a `JaxbLink`. Parameters v:Link instance of type `Link`. Returns:Link.JaxbLink mapped instance of type `JaxbLink`. Annotations @Override

public Link.JaxbLink marshal(final Link v)

Implements abstract jakarta.xml.bind.annotation.adapters.XmlAdapter.marshal.

Deprecated

as a consequence of Link.JaxbLink being deprecated. See corresponding docs for further information.

Convert a Link into a JaxbLink.

Parameters

v:Link: instance of type Link.

Returns:Link.JaxbLink

mapped instance of type JaxbLink.

Annotations

@Override

unmarshal back to summary

unmarshal	back to summary
public Link unmarshal(final Link.JaxbLink v) Implements abstract jakarta.xml.bind.annotation.adapters.XmlAdapter.unmarshal. Deprecated as a consequence of `Link.JaxbLink` being deprecated. See corresponding docs for further information. Convert a `JaxbLink` into a `Link`. Parameters v:Link.JaxbLink instance of type `JaxbLink`. Returns:Link mapped instance of type `JaxbLink` Annotations @Override

public Link unmarshal(final Link.JaxbLink v)

Implements abstract jakarta.xml.bind.annotation.adapters.XmlAdapter.unmarshal.

Deprecated

as a consequence of Link.JaxbLink being deprecated. See corresponding docs for further information.

Convert a JaxbLink into a Link.

Parameters

v:Link.JaxbLink: instance of type JaxbLink.

Returns:Link

mapped instance of type JaxbLink

Annotations

@Override

jakarta.ws.rs.core back to summary

public Class Link.JaxbLink

Class Inheritance

extends Object

java.lang.Object
jakarta.ws.rs.core.Link.JaxbLink

Annotations

@Deprecated

Deprecated

Value type for jakarta.ws.rs.core.Link that can be marshalled and unmarshalled by JAXB. Note that usage of this class requires the Jakarta XML Binding API and an implementation. The Jakarta RESTful Web Services implementation is not required to provide these dependencies.

Since: 2.0
See Also: jakarta.ws.rs.core.Link.JaxbAdapter

Field Summary

Modifier and Type	Field and Description
private Map<QName, Object>	params
private URI	uri

Constructor Summary

Access	Constructor and Description
public	JaxbLink() Default constructor needed during unmarshalling.
public	JaxbLink(final URI underlying URI. uri) Construct an instance from a URI and no parameters.
public	JaxbLink(final URI underlying URI. uri, final Map<QName, Object> parameters of this link. params) Construct an instance from a URI and some parameters.

Method Summary

Modifier and Type	Method and Description
public boolean	equals(final Object the reference object with which to compare. o) Overrides java.lang.Object.equals. Indicates whether some other object is "equal to" this one.
public Map<QName, Object>	Returns: parameter map. getParams() Get the parameter map for this link.
public URI	Returns: underlying URI. getUri() Get the underlying URI for this link.
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for the object.
pack-priv void	setParams(final Map<QName, Object> params) Set the parameter map for this link.
pack-priv void	setUri(final URI uri) Set the underlying URI for this link.

Inherited from java.lang.Object:: clone finalize getClass notify notifyAll toString wait wait wait

Field Detail

params	back to summary
private Map<QName, Object> params

uri	back to summary
private URI uri

Constructor Detail

JaxbLink	back to summary
public JaxbLink() Default constructor needed during unmarshalling.

JaxbLink	back to summary
public JaxbLink(final URI uri) Construct an instance from a URI and no parameters. Parameters uri:URI underlying URI.

JaxbLink

back to summary

public JaxbLink(final URI uri)

Construct an instance from a URI and no parameters.

Parameters

uri:URI: underlying URI.

JaxbLink

back to summary

public JaxbLink(final URI uri, final Map<QName, Object> params)

Construct an instance from a URI and some parameters.

Parameters

uri:URI: underlying URI.
params:Map<QName, Object>: parameters of this link.

Method Detail

equals back to summary

public boolean equals(final Object o)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

It is reflexive: for any non-null reference value x, x.equals(x) should return true.
It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters

o:Object: the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

Annotations

@Override

getParams

back to summary

public Map<QName, Object> getParams()

Get the parameter map for this link.

Returns:Map<QName, Object>

parameter map.

Annotations

@XmlAnyAttribute

getUri

back to summary

public URI getUri()

Get the underlying URI for this link.

Returns:URI

underlying URI.

Annotations

@XmlAttribute
name:href

hashCode back to summary

public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

Returns:int

a hash code value for this object.

Annotations

@Override

setParams	back to summary
pack-priv void setParams(final Map<QName, Object> params) Set the parameter map for this link. This setter is needed for JAXB unmarshalling.

setUri	back to summary
pack-priv void setUri(final URI uri) Set the underlying URI for this link. This setter is needed for JAXB unmarshalling.

public abstract Class Link

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Interface Link.Builder

Method Summary

Method Detail

public Class Link.JaxbAdapter

Constructor Summary

Method Summary

Constructor Detail

Method Detail

public Class Link.JaxbLink

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail