blob: b56d525a6fce590ec06b015480cd66d00660e54c [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>
<!-- Generated by javadoc -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>HeaderList (Apache Juneau 9.0-B1)</title>
<link rel="stylesheet" type="text/css" href="../../../../../javadoc.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="HeaderList (Apache Juneau 9.0-B1)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":9,"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":9,"i19":9,"i20":9,"i21":10,"i22":10,"i23":10,"i24":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="../../../../../org/apache/juneau/http/header/HeaderBeanMeta.html" title="class in org.apache.juneau.http.header"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/apache/juneau/http/header/HeaderList.Builder.html" title="class in org.apache.juneau.http.header"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/juneau/http/header/HeaderList.html" target="_top">Frames</a></li>
<li><a href="HeaderList.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">org.apache.juneau.http.header</div>
<h2 title="Class HeaderList" class="title">Class HeaderList</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li>org.apache.juneau.http.header.HeaderList</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>Direct Known Subclasses:</dt>
<dd><a href="../../../../../org/apache/juneau/http/header/HeaderList.Void.html" title="class in org.apache.juneau.http.header">HeaderList.Void</a></dd>
</dl>
<hr>
<br>
<pre>public class <a href="../../../../../src-html/org/apache/juneau/http/header/HeaderList.html#line.172">HeaderList</a>
extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></pre>
<div class="block">An immutable list of HTTP headers.
<h5 class='figure'>Example</h5>
<p class='bjava'>
HeaderList <jv>headers</jv> = HeaderList
.<jsm>create</jsm>()
.append(Accept.<jsm>of</jsm>(<js>"text/xml"</js>))
.append(<js>"Content-Type"</js>, ()-&gt;<jsm>getDynamicContentTypeFromSomewhere</jsm>())
.build();
</p>
<p>
Convenience creators are provided for creating lists with minimal code:
<p class='bjava'>
HeaderList <jv>headers</jv> = HeaderList.<jsm>of</jsm>(Accept.<jsf>TEXT_XML</jsf>, ContentType.<jsf>TEXT_XML</jsf>);
</p>
<p>
Header lists are immutable, but can be appended to using the <a href="../../../../../org/apache/juneau/http/header/HeaderList.html#copy--"><code>copy()</code></a> method:
<p class='bjava'>
<jv>headers</jv> = <jv>headers</jv>
.copy()
.append(AcceptEncoding.<jsm>of</jsm>(<js>"identity"</js>))
.build();
</p>
<p>
Static methods are provided on <a href="../../../../../org/apache/juneau/http/HttpHeaders.html" title="class in org.apache.juneau.http"><code>HttpHeaders</code></a> to further simplify creation of header lists.
<p class='bjava'>
<jk>import static</jk> org.apache.juneau.http.HttpHeaders.*;
HeaderList <jv>headers</jv> = <jsm>headerList</jsm>(<jsm>accept</jsm>(<js>"text/xml"</js>), <jsm>contentType</jsm>(<js>"text/xml"</js>));
</p>
<p>
The builder class supports setting default header values (i.e. add a header to the list if it isn't otherwise in the list).
Note that this is different from simply setting a value twice as using default values will not overwrite existing
headers.
<br>The following example notes the distinction:
<p class='bjava'>
<jv>headers</jv> = HeaderList
.<jsm>create</jsm>()
.set(Accept.<jsf>TEXT_PLAIN</jsf>)
.set(Accept.<jsf>TEXT_XML</jsf>)
.build();
<jsm>assertObject</jsm>(<jv>headers</jv>).isString(<js>"[Accept: text/xml]"</js>);
<jv>headers</jv> = HeaderList
.create()
.set(Accept.<jsf>TEXT_PLAIN</jsf>)
.setDefault(Accept.<jsf>TEXT_XML</jsf>)
.build();
<jsm>assertObject</jsm>(<jv>headers</jv>).isString(<js>"[Accept: text/plain]"</js>);
</p>
<p>
Various methods are provided for iterating over the headers in this list to avoid array copies.
<ul class='javatree'>
<li class='jm'><a href="../../../../../org/apache/juneau/http/header/HeaderList.html#forEach-java.util.function.Consumer-"><code>forEach(Consumer)</code></a> / <a href="../../../../../org/apache/juneau/http/header/HeaderList.html#forEach-java.lang.String-java.util.function.Consumer-"><code>forEach(String,Consumer)</code></a> / <a href="../../../../../org/apache/juneau/http/header/HeaderList.html#forEach-java.util.function.Predicate-java.util.function.Consumer-"><code>forEach(Predicate,Consumer)</code></a> - Use consumers to process headers.
<li class='jm'><a href="../../../../../org/apache/juneau/http/header/HeaderList.html#iterator--"><code>iterator()</code></a> / <a href="../../../../../org/apache/juneau/http/header/HeaderList.html#iterator-java.lang.String-"><code>iterator(String)</code></a> - Use an <code>HeaderIterator</code> to process headers.
<li class='jm'><a href="../../../../../org/apache/juneau/http/header/HeaderList.html#stream--"><code>stream()</code></a> / <a href="../../../../../org/apache/juneau/http/header/HeaderList.html#stream-java.lang.String-"><code>stream(String)</code></a> - Use a stream.
</ul>
<p>
In general, try to use these over the <a href="../../../../../org/apache/juneau/http/header/HeaderList.html#getAll--"><code>getAll()</code></a>/<a href="../../../../../org/apache/juneau/http/header/HeaderList.html#getAll-java.lang.String-"><code>getAll(String)</code></a> methods that require array copies.
<p>
The <a href="../../../../../org/apache/juneau/http/header/HeaderList.html#get-java.lang.String-"><code>get(String)</code></a> method is special in that it will collapse multiple headers with the same name into
a single comma-delimited list (see <a href='https://tools.ietf.org/html/rfc2616#section-4.2'>RFC 2616 Section 4.2</a> for rules).
<p>
The <a href="../../../../../org/apache/juneau/http/header/HeaderList.html#get-java.lang.Class-"><code>get(Class)</code></a> and <a href="../../../../../org/apache/juneau/http/header/HeaderList.html#get-java.lang.String-java.lang.Class-"><code>get(String, Class)</code></a> methods are provided for working with <a href="../../../../../org/apache/juneau/http/annotation/Header.html" title="annotation in org.apache.juneau.http.annotation"><code>Header</code></a>-annotated
beans.
<h5 class='figure'>Example</h5>
<p class='bjava'>
ContentType <jv>contentType</jv> = <jv>headers</jv>.get(ContentType.<jk>class</jk>);
</p>
<p>
By default, header names are treated as case-insensitive. This can be changed using the <a href="../../../../../org/apache/juneau/http/header/HeaderList.Builder.html#caseSensitive--"><code>HeaderList.Builder.caseSensitive()</code></a>
method.
<p>
A <a href="../../../../../org/apache/juneau/svl/VarResolver.html" title="class in org.apache.juneau.svl"><code>VarResolver</code></a> can be associated with this builder to create header values with embedded variables that
are resolved at runtime.
<h5 class='figure'>Example</h5>
<p class='bjava'>
<jc>// Create a header list with dynamically-resolving values pulled from a system property.</jc>
System.<jsm>setProperty</jsm>(<js>"foo"</js>, <js>"bar"</js>);
HeaderList <jv>headers</jv> = HeaderList
.<jsm>create</jsm>()
.resolving()
.append(<js>"X1"</js>, <js>"$S{foo}"</js>)
.append(<js>"X2"</js>, ()-&gt;<js>"$S{foo}"</js>)
.build();
<jsm>assertObject</jsm>(<jv>headers</jv>).isString(<js>"[X1: bar, X2: bar]"</js>);
</p>
<p>
The <a href="../../../../../org/apache/juneau/http/header/HeaderList.html" title="class in org.apache.juneau.http.header"><code>HeaderList</code></a> object can be extended to defined pre-packaged lists of headers which can be used in various
annotations throughout the framework.
<h5 class='figure'>Example</h5>
<p class='bjava'>
<jc>// A predefined list of headers.</jc>
<jk>public class</jk> MyHeaderList <jk>extends</jk> HeaderList {
<jk>public</jk> MyHeaderList() {
<jk>super</jk>(Accept.<jsf>TEXT_XML</jsf>, ContentType.<jsf>TEXT_XML</jsf>);
}
}
<jc>// Use it on a remote proxy to add headers on all requests.</jc>
<ja>@Remote</ja>(path=<js>"/petstore"</js>, headerList=MyHeaderList.<jk>class</jk>)
<jk>public interface</jk> PetStore {
<ja>@RemotePost</ja>(<js>"/pets"</js>)
Pet addPet(
<ja>@Content</ja> CreatePet <jv>createPet</jv>,
<ja>@Header</ja>(<js>"E-Tag"</js>) UUID <jv>etag</jv>,
<ja>@Query</ja>(<js>"debug"</js>) <jk>boolean</jk> <jv>debug</jv>
);
}
</p>
<ul class='notes'>
<li class='note'>This class is thread safe.
</ul>
<ul class='seealso'>
<li class='link'><a class='doclink' href='../../../../../overview-summary.html#juneau-marshall.jm.HttpParts'>Overview &gt; juneau-marshall &gt; HTTP Parts</a>
<li class='extlink'><a class='doclink' target='_blank' href='https://github.com/apache/juneau/blob/master/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/header/HeaderList.java'>Source</a>
</ul></div>
</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="../../../../../org/apache/juneau/http/header/HeaderList.Builder.html" title="class in org.apache.juneau.http.header">HeaderList.Builder</a></span></code>
<div class="block">Builder class.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static class&nbsp;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/http/header/HeaderList.Void.html" title="class in org.apache.juneau.http.header">HeaderList.Void</a></span></code>
<div class="block">Represents no header supplier in annotations.</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 <a href="../../../../../org/apache/juneau/http/header/HeaderList.html" title="class in org.apache.juneau.http.header">HeaderList</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/http/header/HeaderList.html#EMPTY">EMPTY</a></span></code>
<div class="block">Predefined instance.</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="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="../../../../../org/apache/juneau/http/header/HeaderList.html#HeaderList--">HeaderList</a></span>()</code>
<div class="block">Default constructor.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected </code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/http/header/HeaderList.html#HeaderList-org.apache.http.Header...-">HeaderList</a></span>(org.apache.http.Header...&nbsp;headers)</code>
<div class="block">Constructor.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>&nbsp;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/http/header/HeaderList.html#HeaderList-org.apache.juneau.http.header.HeaderList.Builder-">HeaderList</a></span>(<a href="../../../../../org/apache/juneau/http/header/HeaderList.Builder.html" title="class in org.apache.juneau.http.header">HeaderList.Builder</a>&nbsp;builder)</code>
<div class="block">Constructor.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected </code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/http/header/HeaderList.html#HeaderList-java.util.List-">HeaderList</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;org.apache.http.Header&gt;&nbsp;headers)</code>
<div class="block">Constructor.</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>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/http/header/HeaderList.html#contains-java.lang.String-">contains</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;name)</code>
<div class="block">Tests if headers with the given name are contained within this list.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/juneau/http/header/HeaderList.Builder.html" title="class in org.apache.juneau.http.header">HeaderList.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/http/header/HeaderList.html#copy--">copy</a></span>()</code>
<div class="block">Returns a builder initialized with the contents of this bean.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>static <a href="../../../../../org/apache/juneau/http/header/HeaderList.Builder.html" title="class in org.apache.juneau.http.header">HeaderList.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/http/header/HeaderList.html#create--">create</a></span>()</code>
<div class="block">Instantiates a new builder for this bean.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/juneau/http/header/HeaderList.html" title="class in org.apache.juneau.http.header">HeaderList</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/http/header/HeaderList.html#forEach-java.util.function.Consumer-">forEach</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/function/Consumer.html?is-external=true" title="class or interface in java.util.function">Consumer</a>&lt;org.apache.http.Header&gt;&nbsp;action)</code>
<div class="block">Performs an action on all headers in this list.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/juneau/http/header/HeaderList.html" title="class in org.apache.juneau.http.header">HeaderList</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/http/header/HeaderList.html#forEach-java.util.function.Predicate-java.util.function.Consumer-">forEach</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/function/Predicate.html?is-external=true" title="class or interface in java.util.function">Predicate</a>&lt;org.apache.http.Header&gt;&nbsp;filter,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/function/Consumer.html?is-external=true" title="class or interface in java.util.function">Consumer</a>&lt;org.apache.http.Header&gt;&nbsp;action)</code>
<div class="block">Performs an action on all matching headers in this list.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/juneau/http/header/HeaderList.html" title="class in org.apache.juneau.http.header">HeaderList</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/http/header/HeaderList.html#forEach-java.lang.String-java.util.function.Consumer-">forEach</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;name,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/function/Consumer.html?is-external=true" title="class or interface in java.util.function">Consumer</a>&lt;org.apache.http.Header&gt;&nbsp;action)</code>
<div class="block">Performs an action on all headers with the specified name in this list.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/juneau/http/header/HeaderList.html" title="class in org.apache.juneau.http.header">HeaderList</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/http/header/HeaderList.html#forEachValue-java.util.function.Predicate-java.util.function.Consumer-">forEachValue</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/function/Predicate.html?is-external=true" title="class or interface in java.util.function">Predicate</a>&lt;org.apache.http.Header&gt;&nbsp;filter,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/function/Consumer.html?is-external=true" title="class or interface in java.util.function">Consumer</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&gt;&nbsp;action)</code>
<div class="block">Performs an action on the values for all matching headers in this list.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/juneau/http/header/HeaderList.html" title="class in org.apache.juneau.http.header">HeaderList</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/http/header/HeaderList.html#forEachValue-java.lang.String-java.util.function.Consumer-">forEachValue</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;name,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/function/Consumer.html?is-external=true" title="class or interface in java.util.function">Consumer</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&gt;&nbsp;action)</code>
<div class="block">Performs an action on the values of all matching headers in this list.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>&lt;T&gt;&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Optional.html?is-external=true" title="class or interface in java.util">Optional</a>&lt;T&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/http/header/HeaderList.html#get-java.lang.Class-">get</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;T&gt;&nbsp;type)</code>
<div class="block">Gets a header representing all of the header values with the given name.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Optional.html?is-external=true" title="class or interface in java.util">Optional</a>&lt;org.apache.http.Header&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/http/header/HeaderList.html#get-java.lang.String-">get</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;name)</code>
<div class="block">Gets a header representing all of the header values with the given name.</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>&lt;T&gt;&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Optional.html?is-external=true" title="class or interface in java.util">Optional</a>&lt;T&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/http/header/HeaderList.html#get-java.lang.String-java.lang.Class-">get</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;name,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;T&gt;&nbsp;type)</code>
<div class="block">Gets a header representing all of the header values with the given name.</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>org.apache.http.Header[]</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/http/header/HeaderList.html#getAll--">getAll</a></span>()</code>
<div class="block">Gets all of the headers contained within this list.</div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code>org.apache.http.Header[]</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/http/header/HeaderList.html#getAll-java.lang.String-">getAll</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;name)</code>
<div class="block">Gets all of the headers with the given name.</div>
</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Optional.html?is-external=true" title="class or interface in java.util">Optional</a>&lt;org.apache.http.Header&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/http/header/HeaderList.html#getFirst-java.lang.String-">getFirst</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;name)</code>
<div class="block">Gets the first header with the given name.</div>
</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Optional.html?is-external=true" title="class or interface in java.util">Optional</a>&lt;org.apache.http.Header&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/http/header/HeaderList.html#getLast-java.lang.String-">getLast</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;name)</code>
<div class="block">Gets the last header with the given name.</div>
</td>
</tr>
<tr id="i15" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[]</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/http/header/HeaderList.html#getValues-java.lang.String-">getValues</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;name)</code>
<div class="block">Returns all the string values for all headers with the specified name.</div>
</td>
</tr>
<tr id="i16" class="altColor">
<td class="colFirst"><code>org.apache.http.HeaderIterator</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/http/header/HeaderList.html#iterator--">iterator</a></span>()</code>
<div class="block">Returns an iterator over this list of headers.</div>
</td>
</tr>
<tr id="i17" class="rowColor">
<td class="colFirst"><code>org.apache.http.HeaderIterator</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/http/header/HeaderList.html#iterator-java.lang.String-">iterator</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;name)</code>
<div class="block">Returns an iterator over the headers with a given name in this list.</div>
</td>
</tr>
<tr id="i18" class="altColor">
<td class="colFirst"><code>static <a href="../../../../../org/apache/juneau/http/header/HeaderList.html" title="class in org.apache.juneau.http.header">HeaderList</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/http/header/HeaderList.html#of-org.apache.http.Header...-">of</a></span>(org.apache.http.Header...&nbsp;headers)</code>
<div class="block">Creates a new <a href="../../../../../org/apache/juneau/http/header/HeaderList.html" title="class in org.apache.juneau.http.header"><code>HeaderList</code></a> initialized with the specified headers.</div>
</td>
</tr>
<tr id="i19" class="rowColor">
<td class="colFirst"><code>static <a href="../../../../../org/apache/juneau/http/header/HeaderList.html" title="class in org.apache.juneau.http.header">HeaderList</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/http/header/HeaderList.html#of-java.util.List-">of</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;org.apache.http.Header&gt;&nbsp;headers)</code>
<div class="block">Creates a new <a href="../../../../../org/apache/juneau/http/header/HeaderList.html" title="class in org.apache.juneau.http.header"><code>HeaderList</code></a> initialized with the specified headers.</div>
</td>
</tr>
<tr id="i20" class="altColor">
<td class="colFirst"><code>static <a href="../../../../../org/apache/juneau/http/header/HeaderList.html" title="class in org.apache.juneau.http.header">HeaderList</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/http/header/HeaderList.html#ofPairs-java.lang.String...-">ofPairs</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>...&nbsp;pairs)</code>
<div class="block">Creates a new <a href="../../../../../org/apache/juneau/http/header/HeaderList.html" title="class in org.apache.juneau.http.header"><code>HeaderList</code></a> initialized with the specified name/value pairs.</div>
</td>
</tr>
<tr id="i21" class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/http/header/HeaderList.html#size--">size</a></span>()</code>
<div class="block">Returns the number of headers in this list.</div>
</td>
</tr>
<tr id="i22" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/stream/Stream.html?is-external=true" title="class or interface in java.util.stream">Stream</a>&lt;org.apache.http.Header&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/http/header/HeaderList.html#stream--">stream</a></span>()</code>
<div class="block">Returns a stream of the headers in this list.</div>
</td>
</tr>
<tr id="i23" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/stream/Stream.html?is-external=true" title="class or interface in java.util.stream">Stream</a>&lt;org.apache.http.Header&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/http/header/HeaderList.html#stream-java.lang.String-">stream</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;name)</code>
<div class="block">Returns a stream of the headers in this list with the specified name.</div>
</td>
</tr>
<tr id="i24" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/http/header/HeaderList.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.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></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="EMPTY">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>EMPTY</h4>
<pre>public static final&nbsp;<a href="../../../../../org/apache/juneau/http/header/HeaderList.html" title="class in org.apache.juneau.http.header">HeaderList</a> <a href="../../../../../src-html/org/apache/juneau/http/header/HeaderList.html#line.186">EMPTY</a></pre>
<div class="block">Predefined instance.</div>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="HeaderList-org.apache.juneau.http.header.HeaderList.Builder-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>HeaderList</h4>
<pre>public&nbsp;<a href="../../../../../src-html/org/apache/juneau/http/header/HeaderList.html#line.1206">HeaderList</a>(<a href="../../../../../org/apache/juneau/http/header/HeaderList.Builder.html" title="class in org.apache.juneau.http.header">HeaderList.Builder</a>&nbsp;builder)</pre>
<div class="block">Constructor.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>builder</code> - The builder containing the settings for this bean.</dd>
</dl>
</li>
</ul>
<a name="HeaderList-java.util.List-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>HeaderList</h4>
<pre>protected&nbsp;<a href="../../../../../src-html/org/apache/juneau/http/header/HeaderList.html#line.1237">HeaderList</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;org.apache.http.Header&gt;&nbsp;headers)</pre>
<div class="block">Constructor.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>headers</code> - The headers to add to the list.
<br>Can be <jk>null</jk>.
<br><jk>null</jk> entries are ignored.</dd>
</dl>
</li>
</ul>
<a name="HeaderList-org.apache.http.Header...-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>HeaderList</h4>
<pre>protected&nbsp;<a href="../../../../../src-html/org/apache/juneau/http/header/HeaderList.html#line.1252">HeaderList</a>(org.apache.http.Header...&nbsp;headers)</pre>
<div class="block">Constructor.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>headers</code> - The headers to add to the list.
<br><jk>null</jk> entries are ignored.</dd>
</dl>
</li>
</ul>
<a name="HeaderList--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>HeaderList</h4>
<pre>protected&nbsp;<a href="../../../../../src-html/org/apache/juneau/http/header/HeaderList.html#line.1263">HeaderList</a>()</pre>
<div class="block">Default constructor.</div>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="create--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>create</h4>
<pre>public static&nbsp;<a href="../../../../../org/apache/juneau/http/header/HeaderList.Builder.html" title="class in org.apache.juneau.http.header">HeaderList.Builder</a>&nbsp;<a href="../../../../../src-html/org/apache/juneau/http/header/HeaderList.html#line.193">create</a>()</pre>
<div class="block">Instantiates a new builder for this bean.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>A new builder.</dd>
</dl>
</li>
</ul>
<a name="of-java.util.List-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>of</h4>
<pre>public static&nbsp;<a href="../../../../../org/apache/juneau/http/header/HeaderList.html" title="class in org.apache.juneau.http.header">HeaderList</a>&nbsp;<a href="../../../../../src-html/org/apache/juneau/http/header/HeaderList.html#line.206">of</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;org.apache.http.Header&gt;&nbsp;headers)</pre>
<div class="block">Creates a new <a href="../../../../../org/apache/juneau/http/header/HeaderList.html" title="class in org.apache.juneau.http.header"><code>HeaderList</code></a> initialized with the specified headers.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>headers</code> - The headers to add to the list.
<br>Can be <jk>null</jk>.
<br><jk>null</jk> entries are ignored.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>A new unmodifiable instance, never <jk>null</jk>.</dd>
</dl>
</li>
</ul>
<a name="of-org.apache.http.Header...-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>of</h4>
<pre>public static&nbsp;<a href="../../../../../org/apache/juneau/http/header/HeaderList.html" title="class in org.apache.juneau.http.header">HeaderList</a>&nbsp;<a href="../../../../../src-html/org/apache/juneau/http/header/HeaderList.html#line.218">of</a>(org.apache.http.Header...&nbsp;headers)</pre>
<div class="block">Creates a new <a href="../../../../../org/apache/juneau/http/header/HeaderList.html" title="class in org.apache.juneau.http.header"><code>HeaderList</code></a> initialized with the specified headers.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>headers</code> - The headers to add to the list.
<br><jk>null</jk> entries are ignored.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>A new unmodifiable instance, never <jk>null</jk>.</dd>
</dl>
</li>
</ul>
<a name="ofPairs-java.lang.String...-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>ofPairs</h4>
<pre>public static&nbsp;<a href="../../../../../org/apache/juneau/http/header/HeaderList.html" title="class in org.apache.juneau.http.header">HeaderList</a>&nbsp;<a href="../../../../../src-html/org/apache/juneau/http/header/HeaderList.html#line.236">ofPairs</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>...&nbsp;pairs)</pre>
<div class="block">Creates a new <a href="../../../../../org/apache/juneau/http/header/HeaderList.html" title="class in org.apache.juneau.http.header"><code>HeaderList</code></a> initialized with the specified name/value pairs.
<h5 class='figure'>Example</h5>
<p class='bjava'>
HeaderList <jv>headers</jv> = HeaderList.<jsm>ofPairs</jsm>(<js>"Accept"</js>, <js>"text/xml"</js>, <js>"Content-Type"</js>, <js>"text/xml"</js>);
</p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>pairs</code> - Initial list of pairs.
<br>Must be an even number of parameters representing key/value pairs.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>A new instance.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/RuntimeException.html?is-external=true" title="class or interface in java.lang">RuntimeException</a></code> - If odd number of parameters were specified.</dd>
</dl>
</li>
</ul>
<a name="copy--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>copy</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/juneau/http/header/HeaderList.Builder.html" title="class in org.apache.juneau.http.header">HeaderList.Builder</a>&nbsp;<a href="../../../../../src-html/org/apache/juneau/http/header/HeaderList.html#line.1273">copy</a>()</pre>
<div class="block">Returns a builder initialized with the contents of this bean.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>A new builder object.</dd>
</dl>
</li>
</ul>
<a name="get-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>get</h4>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Optional.html?is-external=true" title="class or interface in java.util">Optional</a>&lt;org.apache.http.Header&gt;&nbsp;<a href="../../../../../src-html/org/apache/juneau/http/header/HeaderList.html#line.1287">get</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;name)</pre>
<div class="block">Gets a header representing all of the header values with the given name.
<p>
If more that one header with the given name exists the values will be combined with <js>", "</js> as per
<a href='https://tools.ietf.org/html/rfc2616#section-4.2'>RFC 2616 Section 4.2</a>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>name</code> - The header name.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>A header with a condensed value, or <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Optional.html?is-external=true#empty--" title="class or interface in java.util"><code>Optional.empty()</code></a> if no headers by the given name are present</dd>
</dl>
</li>
</ul>
<a name="get-java.lang.String-java.lang.Class-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>get</h4>
<pre>public&nbsp;&lt;T&gt;&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Optional.html?is-external=true" title="class or interface in java.util">Optional</a>&lt;T&gt;&nbsp;<a href="../../../../../src-html/org/apache/juneau/http/header/HeaderList.html#line.1346">get</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;name,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;T&gt;&nbsp;type)</pre>
<div class="block">Gets a header representing all of the header values with the given name.
<p>
If more that one header with the given name exists the values will be combined with <js>", "</js> as per
<a href='https://tools.ietf.org/html/rfc2616#section-4.2'>RFC 2616 Section 4.2</a>.
<p>
The implementation class must have a public constructor taking in one of the following argument lists:
<ul>
<li><c>X(String <jv>value</jv>)</c>
<li><c>X(Object <jv>value</jv>)</c>
<li><c>X(String <jv>name</jv>, String <jv>value</jv>)</c>
<li><c>X(String <jv>name</jv>, Object <jv>value</jv>)</c>
</ul>
<h5 class='figure'>Example</h5>
<p class='bjava'>
BasicIntegerHeader <jv>age</jv> = headerList.get(<js>"Age"</js>, BasicIntegerHeader.<jk>class</jk>);
</p></div>
<dl>
<dt><span class="paramLabel">Type Parameters:</span></dt>
<dd><code>T</code> - The header implementation class.</dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>name</code> - The header name.</dd>
<dd><code>type</code> - The header implementation class.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>A header with a condensed value or <jk>null</jk> if no headers by the given name are present</dd>
</dl>
</li>
</ul>
<a name="get-java.lang.Class-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>get</h4>
<pre>public&nbsp;&lt;T&gt;&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Optional.html?is-external=true" title="class or interface in java.util">Optional</a>&lt;T&gt;&nbsp;<a href="../../../../../src-html/org/apache/juneau/http/header/HeaderList.html#line.1395">get</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;T&gt;&nbsp;type)</pre>
<div class="block">Gets a header representing all of the header values with the given name.
<p>
Same as <a href="../../../../../org/apache/juneau/http/header/HeaderList.html#get-java.lang.String-java.lang.Class-"><code>get(String, Class)</code></a> but the header name is pulled from the <a href="../../../../../org/apache/juneau/http/annotation/Header.html#name--"><code>Header.name()</code></a> or
<a href="../../../../../org/apache/juneau/http/annotation/Header.html#value--"><code>Header.value()</code></a> annotations.
<h5 class='figure'>Example</h5>
<p class='bjava'>
Age <jv>age</jv> = headerList.get(Age.<jk>class</jk>);
</p></div>
<dl>
<dt><span class="paramLabel">Type Parameters:</span></dt>
<dd><code>T</code> - The return type.</dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>type</code> - The header implementation class.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>A header with a condensed value or <jk>null</jk> if no headers by the given name are present</dd>
</dl>
</li>
</ul>
<a name="getAll-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAll</h4>
<pre>public&nbsp;org.apache.http.Header[]&nbsp;<a href="../../../../../src-html/org/apache/juneau/http/header/HeaderList.html#line.1421">getAll</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;name)</pre>
<div class="block">Gets all of the headers with the given name.
<p>
The returned array maintains the relative order in which the headers were added.
Header name comparison is case insensitive.
Headers with null values are ignored.
Each call creates a new array not backed by this list.
<p>
As a general rule, it's more efficient to use the other methods with consumers to
get headers.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>name</code> - The header name.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>An array containing all matching headers, never <jk>null</jk>.</dd>
</dl>
</li>
</ul>
<a name="getAll--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAll</h4>
<pre>public&nbsp;org.apache.http.Header[]&nbsp;<a href="../../../../../src-html/org/apache/juneau/http/header/HeaderList.html#line.1443">getAll</a>()</pre>
<div class="block">Gets all of the headers contained within this list.
<p>
The returned array maintains the relative order in which the headers were added.
Headers with null values are ignored.
Each call creates a new array not backed by this list.
<p>
As a general rule, it's more efficient to use the other methods with consumers to
get headers.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>An array of all the headers in this list, never <jk>null</jk>.</dd>
</dl>
</li>
</ul>
<a name="size--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>size</h4>
<pre>public&nbsp;int&nbsp;<a href="../../../../../src-html/org/apache/juneau/http/header/HeaderList.html#line.1452">size</a>()</pre>
<div class="block">Returns the number of headers in this list.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The number of headers in this list.</dd>
</dl>
</li>
</ul>
<a name="getFirst-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFirst</h4>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Optional.html?is-external=true" title="class or interface in java.util">Optional</a>&lt;org.apache.http.Header&gt;&nbsp;<a href="../../../../../src-html/org/apache/juneau/http/header/HeaderList.html#line.1465">getFirst</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;name)</pre>
<div class="block">Gets the first header with the given name.
<p>
Header name comparison is case insensitive.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>name</code> - The header name.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The first matching header, or <jk>null</jk> if not found.</dd>
</dl>
</li>
</ul>
<a name="getLast-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getLast</h4>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Optional.html?is-external=true" title="class or interface in java.util">Optional</a>&lt;org.apache.http.Header&gt;&nbsp;<a href="../../../../../src-html/org/apache/juneau/http/header/HeaderList.html#line.1483">getLast</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;name)</pre>
<div class="block">Gets the last header with the given name.
<p>
Header name comparison is case insensitive.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>name</code> - The header name.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The last matching header, or <jk>null</jk> if not found.</dd>
</dl>
</li>
</ul>
<a name="forEachValue-java.util.function.Predicate-java.util.function.Consumer-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>forEachValue</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/juneau/http/header/HeaderList.html" title="class in org.apache.juneau.http.header">HeaderList</a>&nbsp;<a href="../../../../../src-html/org/apache/juneau/http/header/HeaderList.html#line.1499">forEachValue</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/function/Predicate.html?is-external=true" title="class or interface in java.util.function">Predicate</a>&lt;org.apache.http.Header&gt;&nbsp;filter,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/function/Consumer.html?is-external=true" title="class or interface in java.util.function">Consumer</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&gt;&nbsp;action)</pre>
<div class="block">Performs an action on the values for all matching headers in this list.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>filter</code> - A predicate to apply to each element to determine if it should be included. Can be <jk>null</jk>.</dd>
<dd><code>action</code> - An action to perform on each element.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This object.</dd>
</dl>
</li>
</ul>
<a name="forEachValue-java.lang.String-java.util.function.Consumer-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>forEachValue</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/juneau/http/header/HeaderList.html" title="class in org.apache.juneau.http.header">HeaderList</a>&nbsp;<a href="../../../../../src-html/org/apache/juneau/http/header/HeaderList.html#line.1510">forEachValue</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;name,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/function/Consumer.html?is-external=true" title="class or interface in java.util.function">Consumer</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&gt;&nbsp;action)</pre>
<div class="block">Performs an action on the values of all matching headers in this list.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>name</code> - The header name.</dd>
<dd><code>action</code> - An action to perform on each element.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This object.</dd>
</dl>
</li>
</ul>
<a name="getValues-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getValues</h4>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[]&nbsp;<a href="../../../../../src-html/org/apache/juneau/http/header/HeaderList.html#line.1520">getValues</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;name)</pre>
<div class="block">Returns all the string values for all headers with the specified name.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>name</code> - The header name.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>An array containing all values. Never <jk>null</jk>.</dd>
</dl>
</li>
</ul>
<a name="contains-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>contains</h4>
<pre>public&nbsp;boolean&nbsp;<a href="../../../../../src-html/org/apache/juneau/http/header/HeaderList.html#line.1535">contains</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;name)</pre>
<div class="block">Tests if headers with the given name are contained within this list.
<p>
Header name comparison is case insensitive.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>name</code> - The header name.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><jk>true</jk> if at least one header with the name is present.</dd>
</dl>
</li>
</ul>
<a name="iterator--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>iterator</h4>
<pre>public&nbsp;org.apache.http.HeaderIterator&nbsp;<a href="../../../../../src-html/org/apache/juneau/http/header/HeaderList.html#line.1549">iterator</a>()</pre>
<div class="block">Returns an iterator over this list of headers.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>A new iterator over this list of headers.</dd>
</dl>
</li>
</ul>
<a name="iterator-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>iterator</h4>
<pre>public&nbsp;org.apache.http.HeaderIterator&nbsp;<a href="../../../../../src-html/org/apache/juneau/http/header/HeaderList.html#line.1560">iterator</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;name)</pre>
<div class="block">Returns an iterator over the headers with a given name in this list.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>name</code> - The name of the headers over which to iterate, or <jk>null</jk> for all headers</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>A new iterator over the matching headers in this list.</dd>
</dl>
</li>
</ul>
<a name="forEach-java.util.function.Consumer-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>forEach</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/juneau/http/header/HeaderList.html" title="class in org.apache.juneau.http.header">HeaderList</a>&nbsp;<a href="../../../../../src-html/org/apache/juneau/http/header/HeaderList.html#line.1574">forEach</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/function/Consumer.html?is-external=true" title="class or interface in java.util.function">Consumer</a>&lt;org.apache.http.Header&gt;&nbsp;action)</pre>
<div class="block">Performs an action on all headers in this list.
<p>
This is the preferred method for iterating over headers as it does not involve
creation or copy of lists/arrays.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>action</code> - An action to perform on each element.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This object.</dd>
</dl>
</li>
</ul>
<a name="forEach-java.lang.String-java.util.function.Consumer-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>forEach</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/juneau/http/header/HeaderList.html" title="class in org.apache.juneau.http.header">HeaderList</a>&nbsp;<a href="../../../../../src-html/org/apache/juneau/http/header/HeaderList.html#line.1589">forEach</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;name,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/function/Consumer.html?is-external=true" title="class or interface in java.util.function">Consumer</a>&lt;org.apache.http.Header&gt;&nbsp;action)</pre>
<div class="block">Performs an action on all headers with the specified name in this list.
<p>
This is the preferred method for iterating over headers as it does not involve
creation or copy of lists/arrays.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>name</code> - The header name.</dd>
<dd><code>action</code> - An action to perform on each element.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This object.</dd>
</dl>
</li>
</ul>
<a name="forEach-java.util.function.Predicate-java.util.function.Consumer-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>forEach</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/juneau/http/header/HeaderList.html" title="class in org.apache.juneau.http.header">HeaderList</a>&nbsp;<a href="../../../../../src-html/org/apache/juneau/http/header/HeaderList.html#line.1604">forEach</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/function/Predicate.html?is-external=true" title="class or interface in java.util.function">Predicate</a>&lt;org.apache.http.Header&gt;&nbsp;filter,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/function/Consumer.html?is-external=true" title="class or interface in java.util.function">Consumer</a>&lt;org.apache.http.Header&gt;&nbsp;action)</pre>
<div class="block">Performs an action on all matching headers in this list.
<p>
This is the preferred method for iterating over headers as it does not involve
creation or copy of lists/arrays.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>filter</code> - A predicate to apply to each element to determine if it should be included. Can be <jk>null</jk>.</dd>
<dd><code>action</code> - An action to perform on each element.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This object.</dd>
</dl>
</li>
</ul>
<a name="stream--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>stream</h4>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/stream/Stream.html?is-external=true" title="class or interface in java.util.stream">Stream</a>&lt;org.apache.http.Header&gt;&nbsp;<a href="../../../../../src-html/org/apache/juneau/http/header/HeaderList.html#line.1618">stream</a>()</pre>
<div class="block">Returns a stream of the headers in this list.
<p>
This does not involve a copy of the underlying array of <c>Header</c> objects so should perform well.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This object.</dd>
</dl>
</li>
</ul>
<a name="stream-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>stream</h4>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/stream/Stream.html?is-external=true" title="class or interface in java.util.stream">Stream</a>&lt;org.apache.http.Header&gt;&nbsp;<a href="../../../../../src-html/org/apache/juneau/http/header/HeaderList.html#line.1631">stream</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;name)</pre>
<div class="block">Returns a stream of the headers in this list with the specified name.
<p>
This does not involve a copy of the underlying array of <c>Header</c> objects so should perform well.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>name</code> - The header name.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This object.</dd>
</dl>
</li>
</ul>
<a name="toString--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>toString</h4>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;<a href="../../../../../src-html/org/apache/juneau/http/header/HeaderList.html#line.1640">toString</a>()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a></code>&nbsp;in class&nbsp;<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></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="../../../../../org/apache/juneau/http/header/HeaderBeanMeta.html" title="class in org.apache.juneau.http.header"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/apache/juneau/http/header/HeaderList.Builder.html" title="class in org.apache.juneau.http.header"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/juneau/http/header/HeaderList.html" target="_top">Frames</a></li>
<li><a href="HeaderList.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 ======= -->
<p class="legalCopy"><small>Copyright &#169; 2016&#x2013;2022 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</body>
</html>