Google Git
Sign in
apache / tomee-site-pub / 294f8729efbe13f29a64f7a60a72b67641434a45 / . / jakartaee-8.0 / javadoc / javax / ws / rs / core / Link.html
blob: 43a663e036f65b4df402d0ef7f5db9357d7bd105 [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</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";
}
}
catch(err) {
}
//-->
var methods = {"i0":9,"i1":9,"i2":9,"i3":9,"i4":9,"i5":9,"i6":9,"i7":6,"i8":6,"i9":6,"i10":6,"i11":6,"i12":6,"i13":6,"i14":6,"i15":9};
var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],8:["t4","Concrete 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="../../../../javax/ws/rs/core/HttpHeaders.html" title="interface in javax.ws.rs.core"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../javax/ws/rs/core/Link.Builder.html" title="interface in javax.ws.rs.core"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?javax/ws/rs/core/Link.html" target="_top">Frames</a></li>
<li><a href="Link.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><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&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">javax.ws.rs.core</div>
<h2 title="Class Link" class="title">Class Link</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>javax.ws.rs.core.Link</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public abstract class <span class="typeNameLabel">Link</span>
extends java.lang.Object</pre>
<div class="block"><p>Class representing hypermedia links. A hypermedia link may include additional
parameters beyond its underlying URI. Parameters such as <code>rel</code> or <code>type</code>
provide additional meta-data. Links in responses can be <em>followed</em> by
creating an <a href="../../../../javax/ws/rs/client/Invocation.Builder.html" title="interface in javax.ws.rs.client"><code>Invocation.Builder</code></a> or a
<a href="../../../../javax/ws/rs/client/WebTarget.html" title="interface in javax.ws.rs.client"><code>WebTarget</code></a>.</p>
<p>The methods <a href="../../../../javax/ws/rs/core/Link.html#toString--"><code>toString()</code></a> and <a href="../../../../javax/ws/rs/core/Link.html#valueOf-java.lang.String-"><code>valueOf(java.lang.String)</code></a> can be used to serialize
and de-serialize a link into a link header (RFC 5988).</p></div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>2.0</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../javax/ws/rs/client/Client.html#invocation-javax.ws.rs.core.Link-"><code>Client.invocation(javax.ws.rs.core.Link)</code></a>,
<a href="../../../../javax/ws/rs/client/Client.html#target-javax.ws.rs.core.Link-"><code>Client.target(javax.ws.rs.core.Link)</code></a>,
<a href="../../../../javax/ws/rs/core/Response.html#getLink-java.lang.String-"><code>Response.getLink(java.lang.String)</code></a></dd>
</dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="nested.class.summary">
<!-- -->
</a>
<h3>Nested Class Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation">
<caption><span>Nested Classes</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Class and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static interface&nbsp;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../javax/ws/rs/core/Link.Builder.html" title="interface in javax.ws.rs.core">Link.Builder</a></span></code>
<div class="block">Builder class for hypermedia links.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static class&nbsp;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../javax/ws/rs/core/Link.JaxbAdapter.html" title="class in javax.ws.rs.core">Link.JaxbAdapter</a></span></code>
<div class="block">An implementation of JAXB <a href="../../../../javax/xml/bind/annotation/adapters/XmlAdapter.html" title="class in javax.xml.bind.annotation.adapters"><code>XmlAdapter</code></a>
that maps the <a href="../../../../javax/ws/rs/core/Link.html" title="class in javax.ws.rs.core"><code>Link</code></a> type to a value that can be
marshalled and unmarshalled by JAXB.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static class&nbsp;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../javax/ws/rs/core/Link.JaxbLink.html" title="class in javax.ws.rs.core">Link.JaxbLink</a></span></code>
<div class="block">Value type for <a href="../../../../javax/ws/rs/core/Link.html" title="class in javax.ws.rs.core"><code>Link</code></a> that can be marshalled and
unmarshalled by JAXB.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Field and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../javax/ws/rs/core/Link.html#REL">REL</a></span></code>
<div class="block">Rel link param from RFC 5988.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../javax/ws/rs/core/Link.html#TITLE">TITLE</a></span></code>
<div class="block">Title link param from RFC 5988.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../javax/ws/rs/core/Link.html#TYPE">TYPE</a></span></code>
<div class="block">Type link param from RFC 5988.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../javax/ws/rs/core/Link.html#Link--">Link</a></span>()</code>&nbsp;</td>
</tr>
</table>
</li>
</ul>
<!-- ========== 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="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></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><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete 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>static <a href="../../../../javax/ws/rs/core/Link.Builder.html" title="interface in javax.ws.rs.core">Link.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../javax/ws/rs/core/Link.html#fromLink-javax.ws.rs.core.Link-">fromLink</a></span>(<a href="../../../../javax/ws/rs/core/Link.html" title="class in javax.ws.rs.core">Link</a>&nbsp;link)</code>
<div class="block">Create a new builder instance initialized from another link.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>static <a href="../../../../javax/ws/rs/core/Link.Builder.html" title="interface in javax.ws.rs.core">Link.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../javax/ws/rs/core/Link.html#fromMethod-java.lang.Class-java.lang.String-">fromMethod</a></span>(java.lang.Class&lt;?&gt;&nbsp;resource,
java.lang.String&nbsp;method)</code>
<div class="block">Convenience method to build a link from a resource.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>static <a href="../../../../javax/ws/rs/core/Link.Builder.html" title="interface in javax.ws.rs.core">Link.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../javax/ws/rs/core/Link.html#fromPath-java.lang.String-">fromPath</a></span>(java.lang.String&nbsp;path)</code>
<div class="block">Convenience method to build a link from a path.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>static <a href="../../../../javax/ws/rs/core/Link.Builder.html" title="interface in javax.ws.rs.core">Link.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../javax/ws/rs/core/Link.html#fromResource-java.lang.Class-">fromResource</a></span>(java.lang.Class&lt;?&gt;&nbsp;resource)</code>
<div class="block">Convenience method to build a link from a resource.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>static <a href="../../../../javax/ws/rs/core/Link.Builder.html" title="interface in javax.ws.rs.core">Link.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../javax/ws/rs/core/Link.html#fromUri-java.lang.String-">fromUri</a></span>(java.lang.String&nbsp;uri)</code>
<div class="block">Create a new builder instance initialized from an existing URI represented as a string.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>static <a href="../../../../javax/ws/rs/core/Link.Builder.html" title="interface in javax.ws.rs.core">Link.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../javax/ws/rs/core/Link.html#fromUri-java.net.URI-">fromUri</a></span>(java.net.URI&nbsp;uri)</code>
<div class="block">Create a new builder instance initialized from an existing URI.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>static <a href="../../../../javax/ws/rs/core/Link.Builder.html" title="interface in javax.ws.rs.core">Link.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../javax/ws/rs/core/Link.html#fromUriBuilder-javax.ws.rs.core.UriBuilder-">fromUriBuilder</a></span>(<a href="../../../../javax/ws/rs/core/UriBuilder.html" title="class in javax.ws.rs.core">UriBuilder</a>&nbsp;uriBuilder)</code>
<div class="block">Create a new builder instance initialized from a URI builder.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>abstract java.util.Map&lt;java.lang.String,java.lang.String&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../javax/ws/rs/core/Link.html#getParams--">getParams</a></span>()</code>
<div class="block">Returns an immutable map that includes all the link parameters
defined on this link.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>abstract java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../javax/ws/rs/core/Link.html#getRel--">getRel</a></span>()</code>
<div class="block">Returns the value associated with the link <code>rel</code> param, or
<code>null</code> if this param is not specified.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>abstract java.util.List&lt;java.lang.String&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../javax/ws/rs/core/Link.html#getRels--">getRels</a></span>()</code>
<div class="block">Returns the value associated with the link <code>rel</code> param as a list
of strings or the empty list if <code>rel</code> is not defined.</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>abstract java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../javax/ws/rs/core/Link.html#getTitle--">getTitle</a></span>()</code>
<div class="block">Returns the value associated with the link <code>title</code> param, or
<code>null</code> if this param is not specified.</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>abstract java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../javax/ws/rs/core/Link.html#getType--">getType</a></span>()</code>
<div class="block">Returns the value associated with the link <code>type</code> param, or
<code>null</code> if this param is not specified.</div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code>abstract java.net.URI</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../javax/ws/rs/core/Link.html#getUri--">getUri</a></span>()</code>
<div class="block">Returns the underlying URI associated with this link.</div>
</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code>abstract <a href="../../../../javax/ws/rs/core/UriBuilder.html" title="class in javax.ws.rs.core">UriBuilder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../javax/ws/rs/core/Link.html#getUriBuilder--">getUriBuilder</a></span>()</code>
<div class="block">Convenience method that returns a <a href="../../../../javax/ws/rs/core/UriBuilder.html" title="class in javax.ws.rs.core"><code>UriBuilder</code></a>
initialized with this link's underlying URI.</div>
</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code>abstract java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../javax/ws/rs/core/Link.html#toString--">toString</a></span>()</code>
<div class="block">Returns a string representation as a link header (RFC 5988).</div>
</td>
</tr>
<tr id="i15" class="rowColor">
<td class="colFirst"><code>static <a href="../../../../javax/ws/rs/core/Link.html" title="class in javax.ws.rs.core">Link</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../javax/ws/rs/core/Link.html#valueOf-java.lang.String-">valueOf</a></span>(java.lang.String&nbsp;value)</code>
<div class="block">Simple parser to convert link header string representations into a link.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a name="TITLE">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>TITLE</h4>
<pre>public static final&nbsp;java.lang.String TITLE</pre>
<div class="block">Title link param from RFC 5988.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../constant-values.html#javax.ws.rs.core.Link.TITLE">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="REL">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>REL</h4>
<pre>public static final&nbsp;java.lang.String REL</pre>
<div class="block">Rel link param from RFC 5988.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../constant-values.html#javax.ws.rs.core.Link.REL">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="TYPE">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>TYPE</h4>
<pre>public static final&nbsp;java.lang.String TYPE</pre>
<div class="block">Type link param from RFC 5988.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../constant-values.html#javax.ws.rs.core.Link.TYPE">Constant Field Values</a></dd>
</dl>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="Link--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>Link</h4>
<pre>public&nbsp;Link()</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getUri--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getUri</h4>
<pre>public abstract&nbsp;java.net.URI&nbsp;getUri()</pre>
<div class="block">Returns the underlying URI associated with this link.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>underlying URI.</dd>
</dl>
</li>
</ul>
<a name="getUriBuilder--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getUriBuilder</h4>
<pre>public abstract&nbsp;<a href="../../../../javax/ws/rs/core/UriBuilder.html" title="class in javax.ws.rs.core">UriBuilder</a>&nbsp;getUriBuilder()</pre>
<div class="block">Convenience method that returns a <a href="../../../../javax/ws/rs/core/UriBuilder.html" title="class in javax.ws.rs.core"><code>UriBuilder</code></a>
initialized with this link's underlying URI.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>UriBuilder initialized using underlying URI.</dd>
</dl>
</li>
</ul>
<a name="getRel--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getRel</h4>
<pre>public abstract&nbsp;java.lang.String&nbsp;getRel()</pre>
<div class="block">Returns the value associated with the link <code>rel</code> param, or
<code>null</code> if this param is not specified.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>relation types as string or <code>null</code>.</dd>
</dl>
</li>
</ul>
<a name="getRels--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getRels</h4>
<pre>public abstract&nbsp;java.util.List&lt;java.lang.String&gt;&nbsp;getRels()</pre>
<div class="block">Returns the value associated with the link <code>rel</code> param as a list
of strings or the empty list if <code>rel</code> is not defined.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>relation types as list of strings or empty list.</dd>
</dl>
</li>
</ul>
<a name="getTitle--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTitle</h4>
<pre>public abstract&nbsp;java.lang.String&nbsp;getTitle()</pre>
<div class="block">Returns the value associated with the link <code>title</code> param, or
<code>null</code> if this param is not specified.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>value of title parameter or <code>null</code>.</dd>
</dl>
</li>
</ul>
<a name="getType--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getType</h4>
<pre>public abstract&nbsp;java.lang.String&nbsp;getType()</pre>
<div class="block">Returns the value associated with the link <code>type</code> param, or
<code>null</code> if this param is not specified.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>value of type parameter or <code>null</code>.</dd>
</dl>
</li>
</ul>
<a name="getParams--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getParams</h4>
<pre>public abstract&nbsp;java.util.Map&lt;java.lang.String,java.lang.String&gt;&nbsp;getParams()</pre>
<div class="block">Returns an immutable map that includes all the link parameters
defined on this link. If defined, this map will include entries
for <code>rel</code>, <code>title</code> and <code>type</code>.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>immutable map of link parameters.</dd>
</dl>
</li>
</ul>
<a name="toString--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>toString</h4>
<pre>public abstract&nbsp;java.lang.String&nbsp;toString()</pre>
<div class="block">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"</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>toString</code>&nbsp;in class&nbsp;<code>java.lang.Object</code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>string link header representation for this link.</dd>
</dl>
</li>
</ul>
<a name="valueOf-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>valueOf</h4>
<pre>public static&nbsp;<a href="../../../../javax/ws/rs/core/Link.html" title="class in javax.ws.rs.core">Link</a>&nbsp;valueOf(java.lang.String&nbsp;value)</pre>
<div class="block">Simple parser to convert link header string representations into a link.
<pre>
link ::= '<' uri '>' (';' 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>value</code> - String representation.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>newly parsed link.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.IllegalArgumentException</code> - if a syntax error is found.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../javax/ws/rs/core/Link.Builder.html#link-java.lang.String-"><code>Link.Builder.link(java.lang.String)</code></a></dd>
</dl>
</li>
</ul>
<a name="fromUri-java.net.URI-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>fromUri</h4>
<pre>public static&nbsp;<a href="../../../../javax/ws/rs/core/Link.Builder.html" title="interface in javax.ws.rs.core">Link.Builder</a>&nbsp;fromUri(java.net.URI&nbsp;uri)</pre>
<div class="block">Create a new builder instance initialized from an existing URI.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>uri</code> - a URI that will be used to initialize the builder.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a new builder.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.IllegalArgumentException</code> - if uri is <code>null</code>.</dd>
</dl>
</li>
</ul>
<a name="fromUri-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>fromUri</h4>
<pre>public static&nbsp;<a href="../../../../javax/ws/rs/core/Link.Builder.html" title="interface in javax.ws.rs.core">Link.Builder</a>&nbsp;fromUri(java.lang.String&nbsp;uri)</pre>
<div class="block">Create a new builder instance initialized from an existing URI represented as a string.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>uri</code> - a URI that will be used to initialize the builder.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a new builder.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.IllegalArgumentException</code> - if uri is <code>null</code>.</dd>
</dl>
</li>
</ul>
<a name="fromUriBuilder-javax.ws.rs.core.UriBuilder-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>fromUriBuilder</h4>
<pre>public static&nbsp;<a href="../../../../javax/ws/rs/core/Link.Builder.html" title="interface in javax.ws.rs.core">Link.Builder</a>&nbsp;fromUriBuilder(<a href="../../../../javax/ws/rs/core/UriBuilder.html" title="class in javax.ws.rs.core">UriBuilder</a>&nbsp;uriBuilder)</pre>
<div class="block">Create a new builder instance initialized from a URI builder.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>uriBuilder</code> - instance of URI builder.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a new builder.</dd>
</dl>
</li>
</ul>
<a name="fromLink-javax.ws.rs.core.Link-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>fromLink</h4>
<pre>public static&nbsp;<a href="../../../../javax/ws/rs/core/Link.Builder.html" title="interface in javax.ws.rs.core">Link.Builder</a>&nbsp;fromLink(<a href="../../../../javax/ws/rs/core/Link.html" title="class in javax.ws.rs.core">Link</a>&nbsp;link)</pre>
<div class="block">Create a new builder instance initialized from another link.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>link</code> - other link used for initialization.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a new builder.</dd>
</dl>
</li>
</ul>
<a name="fromPath-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>fromPath</h4>
<pre>public static&nbsp;<a href="../../../../javax/ws/rs/core/Link.Builder.html" title="interface in javax.ws.rs.core">Link.Builder</a>&nbsp;fromPath(java.lang.String&nbsp;path)</pre>
<div class="block">Convenience method to build a link from a path. Equivalent to
<code>fromUriBuilder(UriBuilder.fromPath(path))</code>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>path</code> - a URI path that will be used to initialize the Link, may contain
URI template parameters.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a new Link.Builder.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.IllegalArgumentException</code> - if path is <code>null</code>.</dd>
</dl>
</li>
</ul>
<a name="fromResource-java.lang.Class-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>fromResource</h4>
<pre>public static&nbsp;<a href="../../../../javax/ws/rs/core/Link.Builder.html" title="interface in javax.ws.rs.core">Link.Builder</a>&nbsp;fromResource(java.lang.Class&lt;?&gt;&nbsp;resource)</pre>
<div class="block">Convenience method to build a link from a resource. Equivalent to
<code>Link.fromUriBuilder({@link UriBuilder#fromResource UriBuilder.fromResource(resource)})</code>.
Note that the link URI passed to the <code>Link.Builder</code> instance returned by this
method is relative. Should the link be built as absolute, a <a href="../../../../javax/ws/rs/core/Link.Builder.html#baseUri-java.net.URI-"><code>base URI</code></a> has to be specified in the builder prior to building the new link instance.
For example, on a server side a <a href="../../../../javax/ws/rs/core/UriInfo.html#getBaseUri--"><code>UriInfo.getBaseUri()</code></a> may be typically used to define
the base URI of a link created using this method.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>resource</code> - a root resource whose <a href="../../../../javax/ws/rs/Path.html" title="annotation in javax.ws.rs"><code>Path</code></a> value will be used
to initialize the builder.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a new <a href="../../../../javax/ws/rs/core/Link.Builder.html" title="interface in javax.ws.rs.core"><code>link builder</code></a> instance.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.IllegalArgumentException</code> - if resource is not annotated with <a href="../../../../javax/ws/rs/Path.html" title="annotation in javax.ws.rs"><code>Path</code></a>
or resource is <code>null</code>.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../javax/ws/rs/core/UriInfo.html#getBaseUri--"><code>UriInfo.getBaseUri()</code></a></dd>
</dl>
</li>
</ul>
<a name="fromMethod-java.lang.Class-java.lang.String-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>fromMethod</h4>
<pre>public static&nbsp;<a href="../../../../javax/ws/rs/core/Link.Builder.html" title="interface in javax.ws.rs.core">Link.Builder</a>&nbsp;fromMethod(java.lang.Class&lt;?&gt;&nbsp;resource,
java.lang.String&nbsp;method)</pre>
<div class="block">Convenience method to build a link from a resource. Equivalent to
<code>Link.fromUriBuilder({@link UriBuilder#fromMethod(Class, String) UriBuilder.fromMethod(resource, method)})</code>.
Note that the link URI passed to the <code>Link.Builder</code> instance returned by this
method is relative. Should the link be built as absolute, a <a href="../../../../javax/ws/rs/core/Link.Builder.html#baseUri-java.net.URI-"><code>base URI</code></a> has to be specified in the builder prior to building the new link instance.
For example, on a server side a <a href="../../../../javax/ws/rs/core/UriInfo.html#getBaseUri--"><code>UriInfo.getBaseUri()</code></a> may be typically used to define
the base URI of a link created using this method.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>resource</code> - the resource containing the method.</dd>
<dd><code>method</code> - the name of the method whose <a href="../../../../javax/ws/rs/Path.html" title="annotation in javax.ws.rs"><code>Path</code></a> value will be used
to obtain the path to append.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the updated Link.Builder.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.IllegalArgumentException</code> - if resource or method is <code>null</code>, or there is more
than or less than one variant of the method annotated with
<a href="../../../../javax/ws/rs/Path.html" title="annotation in javax.ws.rs"><code>Path</code></a>.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../javax/ws/rs/core/UriInfo.html#getBaseUri--"><code>UriInfo.getBaseUri()</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="../../../../javax/ws/rs/core/HttpHeaders.html" title="interface in javax.ws.rs.core"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../javax/ws/rs/core/Link.Builder.html" title="interface in javax.ws.rs.core"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?javax/ws/rs/core/Link.html" target="_top">Frames</a></li>
<li><a href="Link.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><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&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>