Google Git
Sign in
apache / tomee-site-pub / 43cf80e624a0cecf0f38bef5ef2614bfb2410f57 / . / jakartaee-9.0 / javadoc / jakarta / ws / rs / core / Link.Builder.html
blob: 0e9b37d49f7201e123fdb9f4b41e77fd3b9a04cf [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<title>Link.Builder</title>
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="Link.Builder";
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":6,"i9":6,"i10":6,"i11":6,"i12":6};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-all.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../jakarta/ws/rs/core/Link.html" title="class in jakarta.ws.rs.core"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../jakarta/ws/rs/core/Link.JaxbAdapter.html" title="class in jakarta.ws.rs.core"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?jakarta/ws/rs/core/Link.Builder.html" target="_top">Frames</a></li>
<li><a href="Link.Builder.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">jakarta.ws.rs.core</div>
<h2 title="Interface Link.Builder" class="title">Interface Link.Builder</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>Enclosing class:</dt>
<dd><a href="../../../../jakarta/ws/rs/core/Link.html" title="class in jakarta.ws.rs.core">Link</a></dd>
</dl>
<hr>
<br>
<pre>public static interface <span class="typeNameLabel">Link.Builder</span></pre>
<div class="block">Builder class for hypermedia links.</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>2.0</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../jakarta/ws/rs/core/Link.html" title="class in jakarta.ws.rs.core"><code>Link</code></a></dd>
</dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code><a href="../../../../jakarta/ws/rs/core/Link.Builder.html" title="interface in jakarta.ws.rs.core">Link.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../jakarta/ws/rs/core/Link.Builder.html#baseUri-java.lang.String-">baseUri</a></span>(java.lang.String&nbsp;uri)</code>
<div class="block">Set the base URI as a string for resolution of relative URIs.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="../../../../jakarta/ws/rs/core/Link.Builder.html" title="interface in jakarta.ws.rs.core">Link.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../jakarta/ws/rs/core/Link.Builder.html#baseUri-java.net.URI-">baseUri</a></span>(java.net.URI&nbsp;uri)</code>
<div class="block">Set the base URI for resolution of relative URIs.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="../../../../jakarta/ws/rs/core/Link.html" title="class in jakarta.ws.rs.core">Link</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../jakarta/ws/rs/core/Link.Builder.html#build-java.lang.Object...-">build</a></span>(java.lang.Object...&nbsp;values)</code>
<div class="block">Finish building this link using the supplied values as URI parameters.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="../../../../jakarta/ws/rs/core/Link.html" title="class in jakarta.ws.rs.core">Link</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../jakarta/ws/rs/core/Link.Builder.html#buildRelativized-java.net.URI-java.lang.Object...-">buildRelativized</a></span>(java.net.URI&nbsp;uri,
java.lang.Object...&nbsp;values)</code>
<div class="block">Finish building this link using the supplied values as URI parameters and relativize the result with respect to the
supplied URI.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code><a href="../../../../jakarta/ws/rs/core/Link.Builder.html" title="interface in jakarta.ws.rs.core">Link.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../jakarta/ws/rs/core/Link.Builder.html#link-jakarta.ws.rs.core.Link-">link</a></span>(<a href="../../../../jakarta/ws/rs/core/Link.html" title="class in jakarta.ws.rs.core">Link</a>&nbsp;link)</code>
<div class="block">Initialize builder using another link.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code><a href="../../../../jakarta/ws/rs/core/Link.Builder.html" title="interface in jakarta.ws.rs.core">Link.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../jakarta/ws/rs/core/Link.Builder.html#link-java.lang.String-">link</a></span>(java.lang.String&nbsp;link)</code>
<div class="block">Initialize builder using another link represented as a string.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code><a href="../../../../jakarta/ws/rs/core/Link.Builder.html" title="interface in jakarta.ws.rs.core">Link.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../jakarta/ws/rs/core/Link.Builder.html#param-java.lang.String-java.lang.String-">param</a></span>(java.lang.String&nbsp;name,
java.lang.String&nbsp;value)</code>
<div class="block">Set an arbitrary parameter on this link.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code><a href="../../../../jakarta/ws/rs/core/Link.Builder.html" title="interface in jakarta.ws.rs.core">Link.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../jakarta/ws/rs/core/Link.Builder.html#rel-java.lang.String-">rel</a></span>(java.lang.String&nbsp;rel)</code>
<div class="block">Convenience method to set a link relation.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code><a href="../../../../jakarta/ws/rs/core/Link.Builder.html" title="interface in jakarta.ws.rs.core">Link.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../jakarta/ws/rs/core/Link.Builder.html#title-java.lang.String-">title</a></span>(java.lang.String&nbsp;title)</code>
<div class="block">Convenience method to set a <code>title</code> on this link.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code><a href="../../../../jakarta/ws/rs/core/Link.Builder.html" title="interface in jakarta.ws.rs.core">Link.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../jakarta/ws/rs/core/Link.Builder.html#type-java.lang.String-">type</a></span>(java.lang.String&nbsp;type)</code>
<div class="block">Convenience method to set a <code>type</code> on this link.</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code><a href="../../../../jakarta/ws/rs/core/Link.Builder.html" title="interface in jakarta.ws.rs.core">Link.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../jakarta/ws/rs/core/Link.Builder.html#uri-java.lang.String-">uri</a></span>(java.lang.String&nbsp;uri)</code>
<div class="block">Set underlying string representing URI template for the link being constructed.</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code><a href="../../../../jakarta/ws/rs/core/Link.Builder.html" title="interface in jakarta.ws.rs.core">Link.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../jakarta/ws/rs/core/Link.Builder.html#uri-java.net.URI-">uri</a></span>(java.net.URI&nbsp;uri)</code>
<div class="block">Set underlying URI template for the link being constructed.</div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code><a href="../../../../jakarta/ws/rs/core/Link.Builder.html" title="interface in jakarta.ws.rs.core">Link.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../jakarta/ws/rs/core/Link.Builder.html#uriBuilder-jakarta.ws.rs.core.UriBuilder-">uriBuilder</a></span>(<a href="../../../../jakarta/ws/rs/core/UriBuilder.html" title="class in jakarta.ws.rs.core">UriBuilder</a>&nbsp;uriBuilder)</code>
<div class="block">Set underlying URI builder representing the URI template for the link being constructed.</div>
</td>
</tr>
</table>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="link-jakarta.ws.rs.core.Link-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>link</h4>
<pre><a href="../../../../jakarta/ws/rs/core/Link.Builder.html" title="interface in jakarta.ws.rs.core">Link.Builder</a>&nbsp;link(<a href="../../../../jakarta/ws/rs/core/Link.html" title="class in jakarta.ws.rs.core">Link</a>&nbsp;link)</pre>
<div class="block">Initialize builder using another link. Sets underlying URI and copies all parameters.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>link</code> - other link from which to initialize.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the updated builder.</dd>
</dl>
</li>
</ul>
<a name="link-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>link</h4>
<pre><a href="../../../../jakarta/ws/rs/core/Link.Builder.html" title="interface in jakarta.ws.rs.core">Link.Builder</a>&nbsp;link(java.lang.String&nbsp;link)</pre>
<div class="block">Initialize builder using another link represented as a string. Uses simple parser to convert string representation
into a link.
<pre>
link ::= '&lt;' uri 'gt;' (';' link-param)*
link-param ::= name '=' quoted-string
</pre>
See <a href="http://tools.ietf.org/html/rfc5988">RFC 5988</a> for more information.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>link</code> - other link in string representation.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the updated builder.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.IllegalArgumentException</code> - if string representation of URI is invalid.</dd>
</dl>
</li>
</ul>
<a name="uri-java.net.URI-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>uri</h4>
<pre><a href="../../../../jakarta/ws/rs/core/Link.Builder.html" title="interface in jakarta.ws.rs.core">Link.Builder</a>&nbsp;uri(java.net.URI&nbsp;uri)</pre>
<div class="block">Set underlying URI template for the link being constructed.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>uri</code> - underlying URI for link</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the updated builder.</dd>
</dl>
</li>
</ul>
<a name="uri-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>uri</h4>
<pre><a href="../../../../jakarta/ws/rs/core/Link.Builder.html" title="interface in jakarta.ws.rs.core">Link.Builder</a>&nbsp;uri(java.lang.String&nbsp;uri)</pre>
<div class="block">Set underlying string representing URI template for the link being constructed.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>uri</code> - underlying URI for link.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the updated builder.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.IllegalArgumentException</code> - if string representation of URI is invalid.</dd>
</dl>
</li>
</ul>
<a name="baseUri-java.net.URI-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>baseUri</h4>
<pre><a href="../../../../jakarta/ws/rs/core/Link.Builder.html" title="interface in jakarta.ws.rs.core">Link.Builder</a>&nbsp;baseUri(java.net.URI&nbsp;uri)</pre>
<div class="block">Set the base URI for resolution of relative URIs. If the underlying URI is already absolute, the base URI is ignored.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>uri</code> - base URI for relative links.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the updated builder.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../jakarta/ws/rs/core/Link.html#fromPath-java.lang.String-"><code>Link.fromPath(java.lang.String)</code></a>,
<a href="../../../../jakarta/ws/rs/core/Link.html#fromResource-java.lang.Class-"><code>Link.fromResource(java.lang.Class)</code></a>,
<a href="../../../../jakarta/ws/rs/core/Link.html#fromMethod-java.lang.Class-java.lang.String-"><code>Link.fromMethod(java.lang.Class, java.lang.String)</code></a></dd>
</dl>
</li>
</ul>
<a name="baseUri-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>baseUri</h4>
<pre><a href="../../../../jakarta/ws/rs/core/Link.Builder.html" title="interface in jakarta.ws.rs.core">Link.Builder</a>&nbsp;baseUri(java.lang.String&nbsp;uri)</pre>
<div class="block">Set the base URI as a string for resolution of relative URIs. If the underlying URI is already absolute, the base URI
is ignored.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>uri</code> - base URI for relative links.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the updated builder.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.IllegalArgumentException</code> - if string representation of URI is invalid.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../jakarta/ws/rs/core/Link.html#fromPath-java.lang.String-"><code>Link.fromPath(java.lang.String)</code></a>,
<a href="../../../../jakarta/ws/rs/core/Link.html#fromResource-java.lang.Class-"><code>Link.fromResource(java.lang.Class)</code></a>,
<a href="../../../../jakarta/ws/rs/core/Link.html#fromMethod-java.lang.Class-java.lang.String-"><code>Link.fromMethod(java.lang.Class, java.lang.String)</code></a></dd>
</dl>
</li>
</ul>
<a name="uriBuilder-jakarta.ws.rs.core.UriBuilder-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>uriBuilder</h4>
<pre><a href="../../../../jakarta/ws/rs/core/Link.Builder.html" title="interface in jakarta.ws.rs.core">Link.Builder</a>&nbsp;uriBuilder(<a href="../../../../jakarta/ws/rs/core/UriBuilder.html" title="class in jakarta.ws.rs.core">UriBuilder</a>&nbsp;uriBuilder)</pre>
<div class="block">Set underlying URI builder representing the URI template for the link being constructed.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>uriBuilder</code> - underlying URI builder.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the updated builder.</dd>
</dl>
</li>
</ul>
<a name="rel-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>rel</h4>
<pre><a href="../../../../jakarta/ws/rs/core/Link.Builder.html" title="interface in jakarta.ws.rs.core">Link.Builder</a>&nbsp;rel(java.lang.String&nbsp;rel)</pre>
<div class="block">Convenience method to set a link relation. More than one <code>rel</code> 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.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>rel</code> - relation name.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the updated builder.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.IllegalArgumentException</code> - if the name is <code>null</code>.</dd>
</dl>
</li>
</ul>
<a name="title-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>title</h4>
<pre><a href="../../../../jakarta/ws/rs/core/Link.Builder.html" title="interface in jakarta.ws.rs.core">Link.Builder</a>&nbsp;title(java.lang.String&nbsp;title)</pre>
<div class="block">Convenience method to set a <code>title</code> on this link.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>title</code> - title parameter of this link.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the updated builder.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.IllegalArgumentException</code> - if the title is <code>null</code>.</dd>
</dl>
</li>
</ul>
<a name="type-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>type</h4>
<pre><a href="../../../../jakarta/ws/rs/core/Link.Builder.html" title="interface in jakarta.ws.rs.core">Link.Builder</a>&nbsp;type(java.lang.String&nbsp;type)</pre>
<div class="block">Convenience method to set a <code>type</code> on this link.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>type</code> - type parameter of this link.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the updated builder.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.IllegalArgumentException</code> - if the type is <code>null</code>.</dd>
</dl>
</li>
</ul>
<a name="param-java.lang.String-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>param</h4>
<pre><a href="../../../../jakarta/ws/rs/core/Link.Builder.html" title="interface in jakarta.ws.rs.core">Link.Builder</a>&nbsp;param(java.lang.String&nbsp;name,
java.lang.String&nbsp;value)</pre>
<div class="block">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 <a href="../../../../jakarta/ws/rs/core/Link.Builder.html#build-java.lang.Object...-"><code>build(Object...)</code></a>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>name</code> - the name of the parameter.</dd>
<dd><code>value</code> - the value set for the parameter.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the updated builder.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.IllegalArgumentException</code> - if either the name or value are <code>null</code>.</dd>
</dl>
</li>
</ul>
<a name="build-java.lang.Object...-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>build</h4>
<pre><a href="../../../../jakarta/ws/rs/core/Link.html" title="class in jakarta.ws.rs.core">Link</a>&nbsp;build(java.lang.Object...&nbsp;values)</pre>
<div class="block">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.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>values</code> - parameters used to build underlying URI.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>newly built link.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.IllegalArgumentException</code> - if there are any URI template parameters without a supplied value, or if a value is
<code>null</code>.</dd>
<dd><code><a href="../../../../jakarta/ws/rs/core/UriBuilderException.html" title="class in jakarta.ws.rs.core">UriBuilderException</a></code> - if a URI cannot be constructed based on the current state of the underlying URI builder.</dd>
</dl>
</li>
</ul>
<a name="buildRelativized-java.net.URI-java.lang.Object...-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>buildRelativized</h4>
<pre><a href="../../../../jakarta/ws/rs/core/Link.html" title="class in jakarta.ws.rs.core">Link</a>&nbsp;buildRelativized(java.net.URI&nbsp;uri,
java.lang.Object...&nbsp;values)</pre>
<div class="block">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 <a href="../../../../jakarta/ws/rs/core/Link.Builder.html#build-java.lang.Object...-"><code>build(java.lang.Object[])</code></a>. Note that a base URI can be set
on a relative link using <a href="../../../../jakarta/ws/rs/core/Link.Builder.html#baseUri-java.net.URI-"><code>baseUri(java.net.URI)</code></a>. The state of the builder is unaffected; this
method may be called multiple times on the same builder instance.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>uri</code> - URI used for relativization.</dd>
<dd><code>values</code> - parameters used to build underlying URI.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>newly built link.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.IllegalArgumentException</code> - if there are any URI template parameters without a supplied value, or if a value is
<code>null</code>.</dd>
<dd><code><a href="../../../../jakarta/ws/rs/core/UriBuilderException.html" title="class in jakarta.ws.rs.core">UriBuilderException</a></code> - if a URI cannot be constructed based on the current state of the underlying URI builder.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../jakarta/ws/rs/core/Link.Builder.html#baseUri-java.lang.String-"><code>baseUri(java.lang.String)</code></a>,
<a href="../../../../jakarta/ws/rs/core/Link.Builder.html#baseUri-java.net.URI-"><code>baseUri(java.net.URI)</code></a></dd>
</dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-all.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../jakarta/ws/rs/core/Link.html" title="class in jakarta.ws.rs.core"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../jakarta/ws/rs/core/Link.JaxbAdapter.html" title="class in jakarta.ws.rs.core"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?jakarta/ws/rs/core/Link.Builder.html" target="_top">Frames</a></li>
<li><a href="Link.Builder.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>