blob: 7af964e2c6f481a8e8db40441e383583ce83afff [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>Variant</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="Variant";
}
}
catch(err) {
}
//-->
var methods = {"i0":9,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":9,"i8":9,"i9":10};
var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance 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="../../../../jakarta/ws/rs/core/UriInfo.html" title="interface in jakarta.ws.rs.core"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../jakarta/ws/rs/core/Variant.VariantListBuilder.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/Variant.html" target="_top">Frames</a></li>
<li><a href="Variant.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>Field&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>Field&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">jakarta.ws.rs.core</div>
<h2 title="Class Variant" class="title">Class Variant</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>jakarta.ws.rs.core.Variant</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public class <span class="typeNameLabel">Variant</span>
extends java.lang.Object</pre>
<div class="block">Abstraction for a resource representation variant.
Contains information about media type, language and encoding of the resource representation.</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>1.0</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 class&nbsp;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../jakarta/ws/rs/core/Variant.VariantListBuilder.html" title="class in jakarta.ws.rs.core">Variant.VariantListBuilder</a></span></code>
<div class="block">A builder for a list of representation variants.</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="../../../../jakarta/ws/rs/core/Variant.html#Variant-jakarta.ws.rs.core.MediaType-java.util.Locale-java.lang.String-">Variant</a></span>(<a href="../../../../jakarta/ws/rs/core/MediaType.html" title="class in jakarta.ws.rs.core">MediaType</a>&nbsp;mediaType,
java.util.Locale&nbsp;language,
java.lang.String&nbsp;encoding)</code>
<div class="block">Create a new instance of Variant.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../jakarta/ws/rs/core/Variant.html#Variant-jakarta.ws.rs.core.MediaType-java.lang.String-java.lang.String-">Variant</a></span>(<a href="../../../../jakarta/ws/rs/core/MediaType.html" title="class in jakarta.ws.rs.core">MediaType</a>&nbsp;mediaType,
java.lang.String&nbsp;language,
java.lang.String&nbsp;encoding)</code>
<div class="block">Create a new instance of Variant.</div>
</td>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../jakarta/ws/rs/core/Variant.html#Variant-jakarta.ws.rs.core.MediaType-java.lang.String-java.lang.String-java.lang.String-">Variant</a></span>(<a href="../../../../jakarta/ws/rs/core/MediaType.html" title="class in jakarta.ws.rs.core">MediaType</a>&nbsp;mediaType,
java.lang.String&nbsp;language,
java.lang.String&nbsp;country,
java.lang.String&nbsp;encoding)</code>
<div class="block">Create a new instance of Variant.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../jakarta/ws/rs/core/Variant.html#Variant-jakarta.ws.rs.core.MediaType-java.lang.String-java.lang.String-java.lang.String-java.lang.String-">Variant</a></span>(<a href="../../../../jakarta/ws/rs/core/MediaType.html" title="class in jakarta.ws.rs.core">MediaType</a>&nbsp;mediaType,
java.lang.String&nbsp;language,
java.lang.String&nbsp;country,
java.lang.String&nbsp;languageVariant,
java.lang.String&nbsp;encoding)</code>
<div class="block">Create a new instance of Variant.</div>
</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="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="../../../../jakarta/ws/rs/core/Variant.VariantListBuilder.html" title="class in jakarta.ws.rs.core">Variant.VariantListBuilder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../jakarta/ws/rs/core/Variant.html#encodings-java.lang.String...-">encodings</a></span>(java.lang.String...&nbsp;encodings)</code>
<div class="block">Create a <a href="../../../../jakarta/ws/rs/core/Variant.VariantListBuilder.html" title="class in jakarta.ws.rs.core"><code>Variant.VariantListBuilder</code></a> initialized with a set of supported encodings.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../jakarta/ws/rs/core/Variant.html#equals-java.lang.Object-">equals</a></span>(java.lang.Object&nbsp;obj)</code>
<div class="block">Compares obj to this variant to see if they are the same considering all property values.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../jakarta/ws/rs/core/Variant.html#getEncoding--">getEncoding</a></span>()</code>
<div class="block">Get the encoding of the variant.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>java.util.Locale</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../jakarta/ws/rs/core/Variant.html#getLanguage--">getLanguage</a></span>()</code>
<div class="block">Get the language of the variant.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../jakarta/ws/rs/core/Variant.html#getLanguageString--">getLanguageString</a></span>()</code>
<div class="block">Get the string representation of the variant language, or <code>null</code> if no language has been set.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code><a href="../../../../jakarta/ws/rs/core/MediaType.html" title="class in jakarta.ws.rs.core">MediaType</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../jakarta/ws/rs/core/Variant.html#getMediaType--">getMediaType</a></span>()</code>
<div class="block">Get the media type of the variant.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../jakarta/ws/rs/core/Variant.html#hashCode--">hashCode</a></span>()</code>
<div class="block">Generate hash code from variant properties.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>static <a href="../../../../jakarta/ws/rs/core/Variant.VariantListBuilder.html" title="class in jakarta.ws.rs.core">Variant.VariantListBuilder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../jakarta/ws/rs/core/Variant.html#languages-java.util.Locale...-">languages</a></span>(java.util.Locale...&nbsp;languages)</code>
<div class="block">Create a <a href="../../../../jakarta/ws/rs/core/Variant.VariantListBuilder.html" title="class in jakarta.ws.rs.core"><code>Variant.VariantListBuilder</code></a> initialized with a set of supported languages.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>static <a href="../../../../jakarta/ws/rs/core/Variant.VariantListBuilder.html" title="class in jakarta.ws.rs.core">Variant.VariantListBuilder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../jakarta/ws/rs/core/Variant.html#mediaTypes-jakarta.ws.rs.core.MediaType...-">mediaTypes</a></span>(<a href="../../../../jakarta/ws/rs/core/MediaType.html" title="class in jakarta.ws.rs.core">MediaType</a>...&nbsp;mediaTypes)</code>
<div class="block">Create a <a href="../../../../jakarta/ws/rs/core/Variant.VariantListBuilder.html" title="class in jakarta.ws.rs.core"><code>Variant.VariantListBuilder</code></a> initialized with a set of supported media types.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../jakarta/ws/rs/core/Variant.html#toString--">toString</a></span>()</code>&nbsp;</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, finalize, getClass, notify, notifyAll, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="Variant-jakarta.ws.rs.core.MediaType-java.lang.String-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Variant</h4>
<pre>public&nbsp;Variant(<a href="../../../../jakarta/ws/rs/core/MediaType.html" title="class in jakarta.ws.rs.core">MediaType</a>&nbsp;mediaType,
java.lang.String&nbsp;language,
java.lang.String&nbsp;encoding)</pre>
<div class="block">Create a new instance of Variant.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>mediaType</code> - the media type of the variant - may be <code>null</code>.</dd>
<dd><code>language</code> - the language of the variant (two-letter ISO-639 code); may be <code>null</code>.</dd>
<dd><code>encoding</code> - the content encoding of the variant - may be <code>null</code>.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.IllegalArgumentException</code> - if all the parameters are <code>null</code>.</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>2.0</dd>
</dl>
</li>
</ul>
<a name="Variant-jakarta.ws.rs.core.MediaType-java.lang.String-java.lang.String-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Variant</h4>
<pre>public&nbsp;Variant(<a href="../../../../jakarta/ws/rs/core/MediaType.html" title="class in jakarta.ws.rs.core">MediaType</a>&nbsp;mediaType,
java.lang.String&nbsp;language,
java.lang.String&nbsp;country,
java.lang.String&nbsp;encoding)</pre>
<div class="block">Create a new instance of Variant.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>mediaType</code> - the media type of the variant - may be <code>null</code>.</dd>
<dd><code>language</code> - the language of the variant (two-letter ISO-639 code); may be <code>null</code>.</dd>
<dd><code>country</code> - uppercase two-letter ISO-3166 language code of the variant; may be <code>null</code> provided
<code>language</code> is <code>null</code> too.</dd>
<dd><code>encoding</code> - the content encoding of the variant - may be <code>null</code>.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.IllegalArgumentException</code> - if all the parameters are <code>null</code>.</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>2.0</dd>
</dl>
</li>
</ul>
<a name="Variant-jakarta.ws.rs.core.MediaType-java.lang.String-java.lang.String-java.lang.String-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Variant</h4>
<pre>public&nbsp;Variant(<a href="../../../../jakarta/ws/rs/core/MediaType.html" title="class in jakarta.ws.rs.core">MediaType</a>&nbsp;mediaType,
java.lang.String&nbsp;language,
java.lang.String&nbsp;country,
java.lang.String&nbsp;languageVariant,
java.lang.String&nbsp;encoding)</pre>
<div class="block">Create a new instance of Variant.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>mediaType</code> - the media type of the variant - may be <code>null</code>.</dd>
<dd><code>language</code> - the language of the variant (two-letter ISO-639 code); may be <code>null</code>.</dd>
<dd><code>country</code> - uppercase two-letter ISO-3166 language code of the variant; may be <code>null</code> provided
<code>language</code> is <code>null</code> too.</dd>
<dd><code>languageVariant</code> - vendor and browser specific language code of the variant (see also <code>Locale</code> class
description); may be <code>null</code> provided <code>language</code> and <code>country</code> are <code>null</code> too.</dd>
<dd><code>encoding</code> - the content encoding of the variant - may be <code>null</code>.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.IllegalArgumentException</code> - if all the parameters are <code>null</code>.</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>2.0</dd>
</dl>
</li>
</ul>
<a name="Variant-jakarta.ws.rs.core.MediaType-java.util.Locale-java.lang.String-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>Variant</h4>
<pre>public&nbsp;Variant(<a href="../../../../jakarta/ws/rs/core/MediaType.html" title="class in jakarta.ws.rs.core">MediaType</a>&nbsp;mediaType,
java.util.Locale&nbsp;language,
java.lang.String&nbsp;encoding)</pre>
<div class="block">Create a new instance of Variant.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>mediaType</code> - the media type of the variant - may be <code>null</code>.</dd>
<dd><code>language</code> - the language of the variant - may be <code>null</code>.</dd>
<dd><code>encoding</code> - the content encoding of the variant - may be <code>null</code>.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.IllegalArgumentException</code> - if all the parameters are <code>null</code>.</dd>
</dl>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getLanguage--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getLanguage</h4>
<pre>public&nbsp;java.util.Locale&nbsp;getLanguage()</pre>
<div class="block">Get the language of the variant.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the language or <code>null</code> if none set.</dd>
</dl>
</li>
</ul>
<a name="getLanguageString--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getLanguageString</h4>
<pre>public&nbsp;java.lang.String&nbsp;getLanguageString()</pre>
<div class="block">Get the string representation of the variant language, or <code>null</code> if no language has been set.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the string representing variant language or <code>null</code> if none set.</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>2.0</dd>
</dl>
</li>
</ul>
<a name="getMediaType--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMediaType</h4>
<pre>public&nbsp;<a href="../../../../jakarta/ws/rs/core/MediaType.html" title="class in jakarta.ws.rs.core">MediaType</a>&nbsp;getMediaType()</pre>
<div class="block">Get the media type of the variant.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the media type or <code>null</code> if none set.</dd>
</dl>
</li>
</ul>
<a name="getEncoding--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getEncoding</h4>
<pre>public&nbsp;java.lang.String&nbsp;getEncoding()</pre>
<div class="block">Get the encoding of the variant.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the encoding or <code>null</code> if none set.</dd>
</dl>
</li>
</ul>
<a name="mediaTypes-jakarta.ws.rs.core.MediaType...-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>mediaTypes</h4>
<pre>public static&nbsp;<a href="../../../../jakarta/ws/rs/core/Variant.VariantListBuilder.html" title="class in jakarta.ws.rs.core">Variant.VariantListBuilder</a>&nbsp;mediaTypes(<a href="../../../../jakarta/ws/rs/core/MediaType.html" title="class in jakarta.ws.rs.core">MediaType</a>...&nbsp;mediaTypes)</pre>
<div class="block">Create a <a href="../../../../jakarta/ws/rs/core/Variant.VariantListBuilder.html" title="class in jakarta.ws.rs.core"><code>Variant.VariantListBuilder</code></a> initialized with a set of supported media types.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>mediaTypes</code> - the available mediaTypes. If specific char-sets are supported they should be included as parameters
of the respective media type.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the initialized builder.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.IllegalArgumentException</code> - if mediaTypes is null or contains no elements.</dd>
</dl>
</li>
</ul>
<a name="languages-java.util.Locale...-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>languages</h4>
<pre>public static&nbsp;<a href="../../../../jakarta/ws/rs/core/Variant.VariantListBuilder.html" title="class in jakarta.ws.rs.core">Variant.VariantListBuilder</a>&nbsp;languages(java.util.Locale...&nbsp;languages)</pre>
<div class="block">Create a <a href="../../../../jakarta/ws/rs/core/Variant.VariantListBuilder.html" title="class in jakarta.ws.rs.core"><code>Variant.VariantListBuilder</code></a> initialized with a set of supported languages.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>languages</code> - the available languages.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the initialized builder.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.IllegalArgumentException</code> - if languages is null or contains no elements.</dd>
</dl>
</li>
</ul>
<a name="encodings-java.lang.String...-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>encodings</h4>
<pre>public static&nbsp;<a href="../../../../jakarta/ws/rs/core/Variant.VariantListBuilder.html" title="class in jakarta.ws.rs.core">Variant.VariantListBuilder</a>&nbsp;encodings(java.lang.String...&nbsp;encodings)</pre>
<div class="block">Create a <a href="../../../../jakarta/ws/rs/core/Variant.VariantListBuilder.html" title="class in jakarta.ws.rs.core"><code>Variant.VariantListBuilder</code></a> initialized with a set of supported encodings.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>encodings</code> - the available encodings.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the initialized builder.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.IllegalArgumentException</code> - if encodings is null or contains no elements.</dd>
</dl>
</li>
</ul>
<a name="hashCode--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>hashCode</h4>
<pre>public&nbsp;int&nbsp;hashCode()</pre>
<div class="block">Generate hash code from variant properties.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>hashCode</code>&nbsp;in class&nbsp;<code>java.lang.Object</code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the hash code.</dd>
</dl>
</li>
</ul>
<a name="equals-java.lang.Object-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>equals</h4>
<pre>public&nbsp;boolean&nbsp;equals(java.lang.Object&nbsp;obj)</pre>
<div class="block">Compares obj to this variant to see if they are the same considering all property values.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>equals</code>&nbsp;in class&nbsp;<code>java.lang.Object</code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>obj</code> - the object to compare to.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true if the two variants are the same, false otherwise.</dd>
</dl>
</li>
</ul>
<a name="toString--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>toString</h4>
<pre>public&nbsp;java.lang.String&nbsp;toString()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>toString</code>&nbsp;in class&nbsp;<code>java.lang.Object</code></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/UriInfo.html" title="interface in jakarta.ws.rs.core"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../jakarta/ws/rs/core/Variant.VariantListBuilder.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/Variant.html" target="_top">Frames</a></li>
<li><a href="Variant.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>Field&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>Field&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>