Package javax.ws.rs.core
Interface Link.Builder
- Enclosing class:
- Link
public static interface Link.Builder
Builder class for hypermedia links.
- Since:
- 2.0
- See Also:
-
Method Summary
Modifier and TypeMethodDescriptionSet the base URI as a string for resolution of relative URIs.Set the base URI for resolution of relative URIs.Finish building this link using the supplied values as URI parameters.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.Initialize builder using another link represented as a string.Initialize builder using another link.Set an arbitrary parameter on this link.Convenience method to set a link relation.Convenience method to set atitle
on this link.Convenience method to set atype
on this link.Set underlying string representing URI template for the link being constructed.Set underlying URI template for the link being constructed.uriBuilder
(UriBuilder uriBuilder) Set underlying URI builder representing the URI template for the link being constructed.
-
Method Details
-
link
Initialize builder using another link. Sets underlying URI and copies all parameters.- Parameters:
link
- other link from which to initialize.- Returns:
- the updated builder.
-
link
Initialize builder using another link represented as a string. Uses simple parser to convert string representation into a link.link ::= '<' uri '>' (';' link-param)* link-param ::= name '=' quoted-string
See RFC 5988 for more information.- Parameters:
link
- other link in string representation.- Returns:
- the updated builder.
- Throws:
IllegalArgumentException
- if string representation of URI is invalid.
-
uri
Set underlying URI template for the link being constructed.- Parameters:
uri
- underlying URI for link- Returns:
- the updated builder.
-
uri
Set underlying string representing URI template for the link being constructed.- Parameters:
uri
- underlying URI for link.- Returns:
- the updated builder.
- Throws:
IllegalArgumentException
- if string representation of URI is invalid.
-
baseUri
Set the base URI for resolution of relative URIs. If the underlying URI is already absolute, the base URI is ignored.- Parameters:
uri
- base URI for relative links.- Returns:
- the updated builder.
- See Also:
-
baseUri
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
- base URI for relative links.- Returns:
- the updated builder.
- Throws:
IllegalArgumentException
- if string representation of URI is invalid.- See Also:
-
uriBuilder
Set underlying URI builder representing the URI template for the link being constructed.- Parameters:
uriBuilder
- underlying URI builder.- Returns:
- the updated builder.
-
rel
Convenience method to set a link relation. More than onerel
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
- relation name.- Returns:
- the updated builder.
- Throws:
IllegalArgumentException
- if the name isnull
.
-
title
Convenience method to set atitle
on this link.- Parameters:
title
- title parameter of this link.- Returns:
- the updated builder.
- Throws:
IllegalArgumentException
- if the title isnull
.
-
type
Convenience method to set atype
on this link.- Parameters:
type
- type parameter of this link.- Returns:
- the updated builder.
- Throws:
IllegalArgumentException
- if the type isnull
.
-
param
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 callingbuild(Object...)
.- Parameters:
name
- the name of the parameter.value
- the value set for the parameter.- Returns:
- the updated builder.
- Throws:
IllegalArgumentException
- if either the name or value arenull
.
-
build
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
- parameters used to build underlying URI.- Returns:
- newly built link.
- Throws:
IllegalArgumentException
- if there are any URI template parameters without a supplied value, or if a value isnull
.UriBuilderException
- if a URI cannot be constructed based on the current state of the underlying URI builder.
-
buildRelativized
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 callingbuild(java.lang.Object[])
. Note that a base URI can be set on a relative link usingbaseUri(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 used for relativization.values
- parameters used to build underlying URI.- Returns:
- newly built link.
- Throws:
IllegalArgumentException
- if there are any URI template parameters without a supplied value, or if a value isnull
.UriBuilderException
- if a URI cannot be constructed based on the current state of the underlying URI builder.- See Also:
-