| <!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.VariantListBuilder</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.VariantListBuilder"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":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="../../../../jakarta/ws/rs/core/Variant.html" title="class in jakarta.ws.rs.core"><span class="typeNameLink">Prev Class</span></a></li> |
| <li>Next Class</li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?jakarta/ws/rs/core/Variant.VariantListBuilder.html" target="_top">Frames</a></li> |
| <li><a href="Variant.VariantListBuilder.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../allclasses-noframe.html">All 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: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </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.VariantListBuilder" class="title">Class Variant.VariantListBuilder</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li>java.lang.Object</li> |
| <li> |
| <ul class="inheritance"> |
| <li>jakarta.ws.rs.core.Variant.VariantListBuilder</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>Enclosing class:</dt> |
| <dd><a href="../../../../jakarta/ws/rs/core/Variant.html" title="class in jakarta.ws.rs.core">Variant</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public abstract static class <span class="typeNameLabel">Variant.VariantListBuilder</span> |
| extends java.lang.Object</pre> |
| <div class="block">A builder for a list of representation variants.</div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ======== 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"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier</th> |
| <th class="colLast" scope="col">Constructor and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../jakarta/ws/rs/core/Variant.VariantListBuilder.html#VariantListBuilder--">VariantListBuilder</a></span>()</code> |
| <div class="block">Protected constructor, use the static <code>newInstance</code> method to obtain an instance.</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"> </span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </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>abstract <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.VariantListBuilder.html#add--">add</a></span>()</code> |
| <div class="block">Add the current combination of metadata to the list of supported variants, after this method is called the current |
| combination of metadata is emptied.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>abstract java.util.List<<a href="../../../../jakarta/ws/rs/core/Variant.html" title="class in jakarta.ws.rs.core">Variant</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../jakarta/ws/rs/core/Variant.VariantListBuilder.html#build--">build</a></span>()</code> |
| <div class="block">Add the current combination of metadata to the list of supported variants (provided the current combination of |
| metadata is not empty) and build a list of representation variants from the current state of the builder.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>abstract <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.VariantListBuilder.html#encodings-java.lang.String...-">encodings</a></span>(java.lang.String... encodings)</code> |
| <div class="block">Set the encoding(s) for this variant.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>abstract <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.VariantListBuilder.html#languages-java.util.Locale...-">languages</a></span>(java.util.Locale... languages)</code> |
| <div class="block">Set the language(s) for this variant.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>abstract <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.VariantListBuilder.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>... mediaTypes)</code> |
| <div class="block">Set the media type(s) for this variant.</div> |
| </td> |
| </tr> |
| <tr id="i5" 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.VariantListBuilder.html#newInstance--">newInstance</a></span>()</code> |
| <div class="block">Create a new builder instance.</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 java.lang.Object</h3> |
| <code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, 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="VariantListBuilder--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>VariantListBuilder</h4> |
| <pre>protected VariantListBuilder()</pre> |
| <div class="block">Protected constructor, use the static <code>newInstance</code> method to obtain an instance.</div> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="newInstance--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>newInstance</h4> |
| <pre>public static <a href="../../../../jakarta/ws/rs/core/Variant.VariantListBuilder.html" title="class in jakarta.ws.rs.core">Variant.VariantListBuilder</a> newInstance()</pre> |
| <div class="block">Create a new builder instance.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a new builder instance.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="build--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>build</h4> |
| <pre>public abstract java.util.List<<a href="../../../../jakarta/ws/rs/core/Variant.html" title="class in jakarta.ws.rs.core">Variant</a>> build()</pre> |
| <div class="block">Add the current combination of metadata to the list of supported variants (provided the current combination of |
| metadata is not empty) and build a list of representation variants from the current state of the builder. After this |
| method is called the builder is reset to an empty state.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a list of representation variants.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="add--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>add</h4> |
| <pre>public abstract <a href="../../../../jakarta/ws/rs/core/Variant.VariantListBuilder.html" title="class in jakarta.ws.rs.core">Variant.VariantListBuilder</a> add()</pre> |
| <div class="block">Add the current combination of metadata to the list of supported variants, after this method is called the current |
| combination of metadata is emptied. |
| <p> |
| If more than one value is supplied for one or more of the variant properties then a variant will be generated for |
| each possible combination. E.g. in the following <code>list</code> would have five (4 + 1) members: |
| </p> |
| |
| <pre> |
| List<Variant> list = VariantListBuilder.newInstance() |
| .languages(Locale.ENGLISH, Locale.FRENCH).encodings("zip", "identity").add() |
| .languages(Locale.GERMAN).mediaTypes(MediaType.TEXT_PLAIN_TYPE).add() |
| .build() |
| </pre> |
| <p> |
| Note that it is not necessary to call the <code>add()</code> method immediately before the build method is called. E.g. |
| the resulting list produced in the example above would be identical to the list produced by the following code: |
| </p> |
| |
| <pre> |
| List<Variant> list = VariantListBuilder.newInstance() |
| .languages(Locale.ENGLISH, Locale.FRENCH).encodings("zip", "identity").add() |
| .languages(Locale.GERMAN).mediaTypes(MediaType.TEXT_PLAIN_TYPE) |
| .build() |
| </pre></div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the updated builder.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.lang.IllegalStateException</code> - if there is not at least one mediaType, language or encoding set for the current |
| variant.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="languages-java.util.Locale...-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>languages</h4> |
| <pre>public abstract <a href="../../../../jakarta/ws/rs/core/Variant.VariantListBuilder.html" title="class in jakarta.ws.rs.core">Variant.VariantListBuilder</a> languages(java.util.Locale... languages)</pre> |
| <div class="block">Set the language(s) for this variant.</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 updated builder.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="encodings-java.lang.String...-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>encodings</h4> |
| <pre>public abstract <a href="../../../../jakarta/ws/rs/core/Variant.VariantListBuilder.html" title="class in jakarta.ws.rs.core">Variant.VariantListBuilder</a> encodings(java.lang.String... encodings)</pre> |
| <div class="block">Set the encoding(s) for this variant.</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 updated builder.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="mediaTypes-jakarta.ws.rs.core.MediaType...-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>mediaTypes</h4> |
| <pre>public abstract <a href="../../../../jakarta/ws/rs/core/Variant.VariantListBuilder.html" title="class in jakarta.ws.rs.core">Variant.VariantListBuilder</a> mediaTypes(<a href="../../../../jakarta/ws/rs/core/MediaType.html" title="class in jakarta.ws.rs.core">MediaType</a>... mediaTypes)</pre> |
| <div class="block">Set the media type(s) for this variant.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>mediaTypes</code> - the available mediaTypes. If specific charsets are supported they should be included as parameters |
| of the respective media type.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the updated builder.</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/Variant.html" title="class in jakarta.ws.rs.core"><span class="typeNameLink">Prev Class</span></a></li> |
| <li>Next Class</li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?jakarta/ws/rs/core/Variant.VariantListBuilder.html" target="_top">Frames</a></li> |
| <li><a href="Variant.VariantListBuilder.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../allclasses-noframe.html">All 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: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </body> |
| </html> |
