jakartaee-9.0/javadoc/jakarta/ws/rs/core/CacheControl.html - tomee-site-pub - Git at Google

 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
 <!-- NewPage -->
 <html lang="en">
 <head>
 <title>CacheControl</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="CacheControl";
         }
     }
     catch(err) {
     }
 //-->
 var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10,"i17":10,"i18":10,"i19":10,"i20":10,"i21":42,"i22":41};
 var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"],32:["t6","Deprecated 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/Application.html" title="class in jakarta.ws.rs.core"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
 <li><a href="../../../../jakarta/ws/rs/core/Configurable.html" title="interface 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/CacheControl.html" target="_top">Frames</a></li>
 <li><a href="CacheControl.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><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 CacheControl" class="title">Class CacheControl</h2>
 </div>
 <div class="contentContainer">
 <ul class="inheritance">
 <li>java.lang.Object</li>
 <li>
 <ul class="inheritance">
 <li>jakarta.ws.rs.core.CacheControl</li>
 </ul>
 </li>
 </ul>
 <div class="description">
 <ul class="blockList">
 <li class="blockList">
 <hr>
 <br>
 <pre>public class <span class="typeNameLabel">CacheControl</span>
 extends java.lang.Object</pre>
 <div class="block">An abstraction for the value of a HTTP Cache-Control response header.</div>
 <dl>
 <dt><span class="simpleTagLabel">Since:</span></dt>
 <dd>1.0</dd>
 <dt><span class="seeLabel">See Also:</span></dt>
 <dd><a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.9">HTTP/1.1 section 14.9</a></dd>
 </dl>
 </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">&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/CacheControl.html#CacheControl--">CacheControl</a></span>()</code>
 <div class="block">Create a new instance of CacheControl.</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><span id="t6" class="tableTab"><span><a href="javascript:show(32);">Deprecated 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>boolean</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../jakarta/ws/rs/core/CacheControl.html#equals-java.lang.Object-">equals</a></span>(java.lang.Object&nbsp;obj)</code>
 <div class="block">Compares object argument to this cache control to see if they are the same considering all property values.</div>
 </td>
 </tr>
 <tr id="i1" class="rowColor">
 <td class="colFirst"><code>java.util.Map&lt;java.lang.String,java.lang.String&gt;</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../jakarta/ws/rs/core/CacheControl.html#getCacheExtension--">getCacheExtension</a></span>()</code>
 <div class="block">Corresponds to a set of extension cache control directives.</div>
 </td>
 </tr>
 <tr id="i2" class="altColor">
 <td class="colFirst"><code>int</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../jakarta/ws/rs/core/CacheControl.html#getMaxAge--">getMaxAge</a></span>()</code>
 <div class="block">Corresponds to the max-age cache control directive.</div>
 </td>
 </tr>
 <tr id="i3" class="rowColor">
 <td class="colFirst"><code>java.util.List&lt;java.lang.String&gt;</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../jakarta/ws/rs/core/CacheControl.html#getNoCacheFields--">getNoCacheFields</a></span>()</code>
 <div class="block">Corresponds to the value of the no-cache cache control directive.</div>
 </td>
 </tr>
 <tr id="i4" class="altColor">
 <td class="colFirst"><code>java.util.List&lt;java.lang.String&gt;</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../jakarta/ws/rs/core/CacheControl.html#getPrivateFields--">getPrivateFields</a></span>()</code>
 <div class="block">Corresponds to the value of the private cache control directive.</div>
 </td>
 </tr>
 <tr id="i5" class="rowColor">
 <td class="colFirst"><code>int</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../jakarta/ws/rs/core/CacheControl.html#getSMaxAge--">getSMaxAge</a></span>()</code>
 <div class="block">Corresponds to the s-maxage cache control directive.</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/CacheControl.html#hashCode--">hashCode</a></span>()</code>
 <div class="block">Generate hash code from cache control properties.</div>
 </td>
 </tr>
 <tr id="i7" class="rowColor">
 <td class="colFirst"><code>boolean</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../jakarta/ws/rs/core/CacheControl.html#isMustRevalidate--">isMustRevalidate</a></span>()</code>
 <div class="block">Corresponds to the must-revalidate cache control directive.</div>
 </td>
 </tr>
 <tr id="i8" class="altColor">
 <td class="colFirst"><code>boolean</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../jakarta/ws/rs/core/CacheControl.html#isNoCache--">isNoCache</a></span>()</code>
 <div class="block">Corresponds to the no-cache cache control directive.</div>
 </td>
 </tr>
 <tr id="i9" class="rowColor">
 <td class="colFirst"><code>boolean</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../jakarta/ws/rs/core/CacheControl.html#isNoStore--">isNoStore</a></span>()</code>
 <div class="block">Corresponds to the no-store cache control directive.</div>
 </td>
 </tr>
 <tr id="i10" class="altColor">
 <td class="colFirst"><code>boolean</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../jakarta/ws/rs/core/CacheControl.html#isNoTransform--">isNoTransform</a></span>()</code>
 <div class="block">Corresponds to the no-transform cache control directive.</div>
 </td>
 </tr>
 <tr id="i11" class="rowColor">
 <td class="colFirst"><code>boolean</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../jakarta/ws/rs/core/CacheControl.html#isPrivate--">isPrivate</a></span>()</code>
 <div class="block">Corresponds to the private cache control directive.</div>
 </td>
 </tr>
 <tr id="i12" class="altColor">
 <td class="colFirst"><code>boolean</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../jakarta/ws/rs/core/CacheControl.html#isProxyRevalidate--">isProxyRevalidate</a></span>()</code>
 <div class="block">Corresponds to the proxy-revalidate cache control directive.</div>
 </td>
 </tr>
 <tr id="i13" class="rowColor">
 <td class="colFirst"><code>void</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../jakarta/ws/rs/core/CacheControl.html#setMaxAge-int-">setMaxAge</a></span>(int&nbsp;maxAge)</code>
 <div class="block">Corresponds to the max-age cache control directive.</div>
 </td>
 </tr>
 <tr id="i14" class="altColor">
 <td class="colFirst"><code>void</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../jakarta/ws/rs/core/CacheControl.html#setMustRevalidate-boolean-">setMustRevalidate</a></span>(boolean&nbsp;mustRevalidate)</code>
 <div class="block">Corresponds to the must-revalidate cache control directive.</div>
 </td>
 </tr>
 <tr id="i15" class="rowColor">
 <td class="colFirst"><code>void</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../jakarta/ws/rs/core/CacheControl.html#setNoCache-boolean-">setNoCache</a></span>(boolean&nbsp;noCache)</code>
 <div class="block">Corresponds to the no-cache cache control directive.</div>
 </td>
 </tr>
 <tr id="i16" class="altColor">
 <td class="colFirst"><code>void</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../jakarta/ws/rs/core/CacheControl.html#setNoStore-boolean-">setNoStore</a></span>(boolean&nbsp;noStore)</code>
 <div class="block">Corresponds to the no-store cache control directive.</div>
 </td>
 </tr>
 <tr id="i17" class="rowColor">
 <td class="colFirst"><code>void</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../jakarta/ws/rs/core/CacheControl.html#setNoTransform-boolean-">setNoTransform</a></span>(boolean&nbsp;noTransform)</code>
 <div class="block">Corresponds to the no-transform cache control directive.</div>
 </td>
 </tr>
 <tr id="i18" class="altColor">
 <td class="colFirst"><code>void</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../jakarta/ws/rs/core/CacheControl.html#setPrivate-boolean-">setPrivate</a></span>(boolean&nbsp;flag)</code>
 <div class="block">Corresponds to the private cache control directive.</div>
 </td>
 </tr>
 <tr id="i19" class="rowColor">
 <td class="colFirst"><code>void</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../jakarta/ws/rs/core/CacheControl.html#setProxyRevalidate-boolean-">setProxyRevalidate</a></span>(boolean&nbsp;proxyRevalidate)</code>
 <div class="block">Corresponds to the must-revalidate cache control directive.</div>
 </td>
 </tr>
 <tr id="i20" class="altColor">
 <td class="colFirst"><code>void</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../jakarta/ws/rs/core/CacheControl.html#setSMaxAge-int-">setSMaxAge</a></span>(int&nbsp;sMaxAge)</code>
 <div class="block">Corresponds to the s-maxage cache control directive.</div>
 </td>
 </tr>
 <tr id="i21" class="rowColor">
 <td class="colFirst"><code>java.lang.String</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../jakarta/ws/rs/core/CacheControl.html#toString--">toString</a></span>()</code>
 <div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;
 <div class="block"><span class="deprecationComment">The format of the toString() method is subject to change in a future version. Please use
  RuntimeDelegate.getInstance().createHeaderDelegate(CacheControl.class).toString(value) instead if you rely on the
  format of this method.</span></div>
 </div>
 </td>
 </tr>
 <tr id="i22" class="altColor">
 <td class="colFirst"><code>static <a href="../../../../jakarta/ws/rs/core/CacheControl.html" title="class in jakarta.ws.rs.core">CacheControl</a></code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../jakarta/ws/rs/core/CacheControl.html#valueOf-java.lang.String-">valueOf</a></span>(java.lang.String&nbsp;value)</code>
 <div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;
 <div class="block"><span class="deprecationComment">This method will be removed in a future version. Please use
  RuntimeDelegate.getInstance().createHeaderDelegate(CacheControl.class).fromString(value) instead.</span></div>
 </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, 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="CacheControl--">
 <!--   -->
 </a>
 <ul class="blockListLast">
 <li class="blockList">
 <h4>CacheControl</h4>
 <pre>public&nbsp;CacheControl()</pre>
 <div class="block">Create a new instance of CacheControl. The new instance will have the following default settings:

  <ul>
  <li>private = false</li>
  <li>noCache = false</li>
  <li>noStore = false</li>
  <li>noTransform = true</li>
  <li>mustRevalidate = false</li>
  <li>proxyRevalidate = false</li>
  <li>An empty list of private fields</li>
  <li>An empty list of no-cache fields</li>
  <li>An empty map of cache extensions</li>
  </ul></div>
 </li>
 </ul>
 </li>
 </ul>
 <!-- ============ METHOD DETAIL ========== -->
 <ul class="blockList">
 <li class="blockList"><a name="method.detail">
 <!--   -->
 </a>
 <h3>Method Detail</h3>
 <a name="valueOf-java.lang.String-">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>valueOf</h4>
 <pre>@Deprecated
 public static&nbsp;<a href="../../../../jakarta/ws/rs/core/CacheControl.html" title="class in jakarta.ws.rs.core">CacheControl</a>&nbsp;valueOf(java.lang.String&nbsp;value)</pre>
 <div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;<span class="deprecationComment">This method will be removed in a future version. Please use
  RuntimeDelegate.getInstance().createHeaderDelegate(CacheControl.class).fromString(value) instead.</span></div>
 <div class="block">Creates a new instance of CacheControl by parsing the supplied string.</div>
 <dl>
 <dt><span class="paramLabel">Parameters:</span></dt>
 <dd><code>value</code> - the cache control string</dd>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>the newly created CacheControl</dd>
 <dt><span class="throwsLabel">Throws:</span></dt>
 <dd><code>java.lang.IllegalArgumentException</code> - if the supplied string cannot be parsed or is null</dd>
 </dl>
 </li>
 </ul>
 <a name="isMustRevalidate--">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>isMustRevalidate</h4>
 <pre>public&nbsp;boolean&nbsp;isMustRevalidate()</pre>
 <div class="block">Corresponds to the must-revalidate cache control directive.</div>
 <dl>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>true if the must-revalidate cache control directive will be included in the response, false otherwise.</dd>
 <dt><span class="seeLabel">See Also:</span></dt>
 <dd><a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.9.4">HTTP/1.1 section 14.9.4</a></dd>
 </dl>
 </li>
 </ul>
 <a name="setMustRevalidate-boolean-">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>setMustRevalidate</h4>
 <pre>public&nbsp;void&nbsp;setMustRevalidate(boolean&nbsp;mustRevalidate)</pre>
 <div class="block">Corresponds to the must-revalidate cache control directive.</div>
 <dl>
 <dt><span class="paramLabel">Parameters:</span></dt>
 <dd><code>mustRevalidate</code> - true if the must-revalidate cache control directive should be included in the response, false
  otherwise.</dd>
 <dt><span class="seeLabel">See Also:</span></dt>
 <dd><a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.9.4">HTTP/1.1 section 14.9.4</a></dd>
 </dl>
 </li>
 </ul>
 <a name="isProxyRevalidate--">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>isProxyRevalidate</h4>
 <pre>public&nbsp;boolean&nbsp;isProxyRevalidate()</pre>
 <div class="block">Corresponds to the proxy-revalidate cache control directive.</div>
 <dl>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>true if the proxy-revalidate cache control directive will be included in the response, false otherwise.</dd>
 <dt><span class="seeLabel">See Also:</span></dt>
 <dd><a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.9.4">HTTP/1.1 section 14.9.4</a></dd>
 </dl>
 </li>
 </ul>
 <a name="setProxyRevalidate-boolean-">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>setProxyRevalidate</h4>
 <pre>public&nbsp;void&nbsp;setProxyRevalidate(boolean&nbsp;proxyRevalidate)</pre>
 <div class="block">Corresponds to the must-revalidate cache control directive.</div>
 <dl>
 <dt><span class="paramLabel">Parameters:</span></dt>
 <dd><code>proxyRevalidate</code> - true if the proxy-revalidate cache control directive should be included in the response, false
  otherwise.</dd>
 <dt><span class="seeLabel">See Also:</span></dt>
 <dd><a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.9.4">HTTP/1.1 section 14.9.4</a></dd>
 </dl>
 </li>
 </ul>
 <a name="getMaxAge--">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>getMaxAge</h4>
 <pre>public&nbsp;int&nbsp;getMaxAge()</pre>
 <div class="block">Corresponds to the max-age cache control directive.</div>
 <dl>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>the value of the max-age cache control directive, -1 if the directive is disabled.</dd>
 <dt><span class="seeLabel">See Also:</span></dt>
 <dd><a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.9.3">HTTP/1.1 section 14.9.3</a></dd>
 </dl>
 </li>
 </ul>
 <a name="setMaxAge-int-">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>setMaxAge</h4>
 <pre>public&nbsp;void&nbsp;setMaxAge(int&nbsp;maxAge)</pre>
 <div class="block">Corresponds to the max-age cache control directive.</div>
 <dl>
 <dt><span class="paramLabel">Parameters:</span></dt>
 <dd><code>maxAge</code> - the value of the max-age cache control directive, a value of -1 will disable the directive.</dd>
 <dt><span class="seeLabel">See Also:</span></dt>
 <dd><a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.9.3">HTTP/1.1 section 14.9.3</a></dd>
 </dl>
 </li>
 </ul>
 <a name="getSMaxAge--">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>getSMaxAge</h4>
 <pre>public&nbsp;int&nbsp;getSMaxAge()</pre>
 <div class="block">Corresponds to the s-maxage cache control directive.</div>
 <dl>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>the value of the s-maxage cache control directive, -1 if the directive is disabled.</dd>
 <dt><span class="seeLabel">See Also:</span></dt>
 <dd><a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.9.3">HTTP/1.1 section 14.9.3</a></dd>
 </dl>
 </li>
 </ul>
 <a name="setSMaxAge-int-">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>setSMaxAge</h4>
 <pre>public&nbsp;void&nbsp;setSMaxAge(int&nbsp;sMaxAge)</pre>
 <div class="block">Corresponds to the s-maxage cache control directive.</div>
 <dl>
 <dt><span class="paramLabel">Parameters:</span></dt>
 <dd><code>sMaxAge</code> - the value of the s-maxage cache control directive, a value of -1 will disable the directive.</dd>
 <dt><span class="seeLabel">See Also:</span></dt>
 <dd><a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.9.3">HTTP/1.1 section 14.9.3</a></dd>
 </dl>
 </li>
 </ul>
 <a name="getNoCacheFields--">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>getNoCacheFields</h4>
 <pre>public&nbsp;java.util.List&lt;java.lang.String&gt;&nbsp;getNoCacheFields()</pre>
 <div class="block">Corresponds to the value of the no-cache cache control directive.</div>
 <dl>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>a mutable list of field-names that will form the value of the no-cache cache control directive. An empty list
  results in a bare no-cache directive.</dd>
 <dt><span class="seeLabel">See Also:</span></dt>
 <dd><a href="../../../../jakarta/ws/rs/core/CacheControl.html#isNoCache--"><code>isNoCache()</code></a>,
 <a href="../../../../jakarta/ws/rs/core/CacheControl.html#setNoCache-boolean-"><code>setNoCache(boolean)</code></a>,
 <a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.9.1">HTTP/1.1 section 14.9.1</a></dd>
 </dl>
 </li>
 </ul>
 <a name="setNoCache-boolean-">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>setNoCache</h4>
 <pre>public&nbsp;void&nbsp;setNoCache(boolean&nbsp;noCache)</pre>
 <div class="block">Corresponds to the no-cache cache control directive.</div>
 <dl>
 <dt><span class="paramLabel">Parameters:</span></dt>
 <dd><code>noCache</code> - true if the no-cache cache control directive should be included in the response, false otherwise.</dd>
 <dt><span class="seeLabel">See Also:</span></dt>
 <dd><a href="../../../../jakarta/ws/rs/core/CacheControl.html#getNoCacheFields--"><code>getNoCacheFields()</code></a>,
 <a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.9.1">HTTP/1.1 section 14.9.1</a></dd>
 </dl>
 </li>
 </ul>
 <a name="isNoCache--">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>isNoCache</h4>
 <pre>public&nbsp;boolean&nbsp;isNoCache()</pre>
 <div class="block">Corresponds to the no-cache cache control directive.</div>
 <dl>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>true if the no-cache cache control directive will be included in the response, false otherwise.</dd>
 <dt><span class="seeLabel">See Also:</span></dt>
 <dd><a href="../../../../jakarta/ws/rs/core/CacheControl.html#getNoCacheFields--"><code>getNoCacheFields()</code></a>,
 <a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.9.1">HTTP/1.1 section 14.9.1</a></dd>
 </dl>
 </li>
 </ul>
 <a name="isPrivate--">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>isPrivate</h4>
 <pre>public&nbsp;boolean&nbsp;isPrivate()</pre>
 <div class="block">Corresponds to the private cache control directive.</div>
 <dl>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>true if the private cache control directive will be included in the response, false otherwise.</dd>
 <dt><span class="seeLabel">See Also:</span></dt>
 <dd><a href="../../../../jakarta/ws/rs/core/CacheControl.html#getPrivateFields--"><code>getPrivateFields()</code></a>,
 <a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.9.1">HTTP/1.1 section 14.9.1</a></dd>
 </dl>
 </li>
 </ul>
 <a name="getPrivateFields--">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>getPrivateFields</h4>
 <pre>public&nbsp;java.util.List&lt;java.lang.String&gt;&nbsp;getPrivateFields()</pre>
 <div class="block">Corresponds to the value of the private cache control directive.</div>
 <dl>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>a mutable list of field-names that will form the value of the private cache control directive. An empty list
  results in a bare no-cache directive.</dd>
 <dt><span class="seeLabel">See Also:</span></dt>
 <dd><a href="../../../../jakarta/ws/rs/core/CacheControl.html#isPrivate--"><code>isPrivate()</code></a>,
 <a href="../../../../jakarta/ws/rs/core/CacheControl.html#setPrivate-boolean-"><code>setPrivate(boolean)</code></a>,
 <a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.9.1">HTTP/1.1 section 14.9.1</a></dd>
 </dl>
 </li>
 </ul>
 <a name="setPrivate-boolean-">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>setPrivate</h4>
 <pre>public&nbsp;void&nbsp;setPrivate(boolean&nbsp;flag)</pre>
 <div class="block">Corresponds to the private cache control directive.</div>
 <dl>
 <dt><span class="paramLabel">Parameters:</span></dt>
 <dd><code>flag</code> - true if the private cache control directive should be included in the response, false otherwise.</dd>
 <dt><span class="seeLabel">See Also:</span></dt>
 <dd><a href="../../../../jakarta/ws/rs/core/CacheControl.html#getPrivateFields--"><code>getPrivateFields()</code></a>,
 <a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.9.1">HTTP/1.1 section 14.9.1</a></dd>
 </dl>
 </li>
 </ul>
 <a name="isNoTransform--">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>isNoTransform</h4>
 <pre>public&nbsp;boolean&nbsp;isNoTransform()</pre>
 <div class="block">Corresponds to the no-transform cache control directive.</div>
 <dl>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>true if the no-transform cache control directive will be included in the response, false otherwise.</dd>
 <dt><span class="seeLabel">See Also:</span></dt>
 <dd><a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.9.5">HTTP/1.1 section 14.9.5</a></dd>
 </dl>
 </li>
 </ul>
 <a name="setNoTransform-boolean-">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>setNoTransform</h4>
 <pre>public&nbsp;void&nbsp;setNoTransform(boolean&nbsp;noTransform)</pre>
 <div class="block">Corresponds to the no-transform cache control directive.</div>
 <dl>
 <dt><span class="paramLabel">Parameters:</span></dt>
 <dd><code>noTransform</code> - true if the no-transform cache control directive should be included in the response, false
  otherwise.</dd>
 <dt><span class="seeLabel">See Also:</span></dt>
 <dd><a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.9.5">HTTP/1.1 section 14.9.5</a></dd>
 </dl>
 </li>
 </ul>
 <a name="isNoStore--">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>isNoStore</h4>
 <pre>public&nbsp;boolean&nbsp;isNoStore()</pre>
 <div class="block">Corresponds to the no-store cache control directive.</div>
 <dl>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>true if the no-store cache control directive will be included in the response, false otherwise.</dd>
 <dt><span class="seeLabel">See Also:</span></dt>
 <dd><a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.9.2">HTTP/1.1 section 14.9.2</a></dd>
 </dl>
 </li>
 </ul>
 <a name="setNoStore-boolean-">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>setNoStore</h4>
 <pre>public&nbsp;void&nbsp;setNoStore(boolean&nbsp;noStore)</pre>
 <div class="block">Corresponds to the no-store cache control directive.</div>
 <dl>
 <dt><span class="paramLabel">Parameters:</span></dt>
 <dd><code>noStore</code> - true if the no-store cache control directive should be included in the response, false otherwise.</dd>
 <dt><span class="seeLabel">See Also:</span></dt>
 <dd><a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.9.2">HTTP/1.1 section 14.9.2</a></dd>
 </dl>
 </li>
 </ul>
 <a name="getCacheExtension--">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>getCacheExtension</h4>
 <pre>public&nbsp;java.util.Map&lt;java.lang.String,java.lang.String&gt;&nbsp;getCacheExtension()</pre>
 <div class="block">Corresponds to a set of extension cache control directives.</div>
 <dl>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>a mutable map of cache control extension names and their values. If a key has a null value, it will appear as
  a bare directive. If a key has a value that contains no whitespace then the directive will appear as a simple
  name=value pair. If a key has a value that contains whitespace then the directive will appear as a quoted
  name="value" pair.</dd>
 <dt><span class="seeLabel">See Also:</span></dt>
 <dd><a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.9.6">HTTP/1.1 section 14.9.6</a></dd>
 </dl>
 </li>
 </ul>
 <a name="toString--">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>toString</h4>
 <pre>@Deprecated
 public&nbsp;java.lang.String&nbsp;toString()</pre>
 <div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;<span class="deprecationComment">The format of the toString() method is subject to change in a future version. Please use
  RuntimeDelegate.getInstance().createHeaderDelegate(CacheControl.class).toString(value) instead if you rely on the
  format of this method.</span></div>
 <div class="block">Convert the cache control to a string suitable for use as the value of the corresponding HTTP header.</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>a stringified cache control</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 cache control 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 hashCode</dd>
 </dl>
 </li>
 </ul>
 <a name="equals-java.lang.Object-">
 <!--   -->
 </a>
 <ul class="blockListLast">
 <li class="blockList">
 <h4>equals</h4>
 <pre>public&nbsp;boolean&nbsp;equals(java.lang.Object&nbsp;obj)</pre>
 <div class="block">Compares object argument to this cache control 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 cache controls are the same, false otherwise.</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/Application.html" title="class in jakarta.ws.rs.core"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
 <li><a href="../../../../jakarta/ws/rs/core/Configurable.html" title="interface 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/CacheControl.html" target="_top">Frames</a></li>
 <li><a href="CacheControl.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><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>