blob: 592828ecee19ea9730234582f0cc9c10c51e2f3b [file] [log] [blame]
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (18) -->
<title>RequestPathParams (Apache Juneau 9.0.0)</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="description" content="declaration: package: org.apache.juneau.rest.httppart, class: RequestPathParams">
<meta name="generator" content="javadoc/ClassWriterImpl">
<link rel="stylesheet" type="text/css" href="../../../../../javadoc.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style">
<script type="text/javascript" src="../../../../../script.js"></script>
<script type="text/javascript" src="../../../../../script-dir/jquery-3.5.1.min.js"></script>
<script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script>
</head>
<body class="class-declaration-page">
<script type="text/javascript">var evenRowColor = "even-row-color";
var oddRowColor = "odd-row-color";
var tableTab = "table-tab";
var activeTableTab = "active-table-tab";
var pathtoroot = "../../../../../";
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<div class="flex-box">
<header role="banner" class="flex-header">
<nav role="navigation">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="top-nav" id="navbar-top"><button id="navbar-toggle-button" aria-controls="navbar-top" aria-expanded="false" aria-label="Toggle navigation links"><span class="nav-bar-toggle-icon"></span><span class="nav-bar-toggle-icon"></span><span class="nav-bar-toggle-icon"></span></button>
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
<li><a href="../../../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="nav-bar-cell1-rev">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#class">Help</a></li>
</ul>
<ul class="sub-nav-list-small">
<li>
<p>Summary:</p>
<ul>
<li>Nested</li>
<li><a href="#field-summary">Field</a></li>
<li><a href="#constructor-summary">Constr</a></li>
<li><a href="#method-summary">Method</a></li>
</ul>
</li>
<li>
<p>Detail:</p>
<ul>
<li>Field</li>
<li><a href="#constructor-detail">Constr</a></li>
<li><a href="#method-detail">Method</a></li>
</ul>
</li>
</ul>
</div>
<div class="sub-nav">
<div id="navbar-sub-list">
<ul class="sub-nav-list">
<li>Summary:&nbsp;</li>
<li>Nested&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="sub-nav-list">
<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>
<div class="nav-list-search"><label for="search-input">SEARCH:</label>
<input type="text" id="search-input" disabled placeholder="Search">
<input type="reset" id="reset-button" disabled value="reset">
</div>
</div>
<!-- ========= END OF TOP NAVBAR ========= -->
<span class="skip-nav" id="skip-navbar-top"></span></nav>
</header>
<div class="flex-content">
<main role="main">
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="sub-title"><span class="package-label-in-type">Package</span>&nbsp;<a href="package-summary.html">org.apache.juneau.rest.httppart</a></div>
<h1 title="Class RequestPathParams" class="title">Class RequestPathParams</h1>
</div>
<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a>
<div class="inheritance"><a href="https://docs.oracle.com/javase/8/docs/api/java/util/AbstractCollection.html" title="class or interface in java.util" class="external-link">java.util.AbstractCollection</a>&lt;E&gt;
<div class="inheritance"><a href="https://docs.oracle.com/javase/8/docs/api/java/util/AbstractList.html" title="class or interface in java.util" class="external-link">java.util.AbstractList</a>&lt;E&gt;
<div class="inheritance"><a href="https://docs.oracle.com/javase/8/docs/api/java/util/ArrayList.html" title="class or interface in java.util" class="external-link">java.util.ArrayList</a>&lt;<a href="RequestPathParam.html" title="class in org.apache.juneau.rest.httppart">RequestPathParam</a>&gt;
<div class="inheritance">org.apache.juneau.rest.httppart.RequestPathParams</div>
</div>
</div>
</div>
</div>
<section class="class-description" id="class-description">
<dl class="notes">
<dt>All Implemented Interfaces:</dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html" title="class or interface in java.io" class="external-link">Serializable</a></code>, <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Cloneable.html" title="class or interface in java.lang" class="external-link">Cloneable</a></code>, <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html" title="class or interface in java.lang" class="external-link">Iterable</a>&lt;<a href="RequestPathParam.html" title="class in org.apache.juneau.rest.httppart">RequestPathParam</a>&gt;</code>, <code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html" title="class or interface in java.util" class="external-link">Collection</a>&lt;<a href="RequestPathParam.html" title="class in org.apache.juneau.rest.httppart">RequestPathParam</a>&gt;</code>, <code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html" title="class or interface in java.util" class="external-link">List</a>&lt;<a href="RequestPathParam.html" title="class in org.apache.juneau.rest.httppart">RequestPathParam</a>&gt;</code>, <code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/RandomAccess.html" title="class or interface in java.util" class="external-link">RandomAccess</a></code></dd>
</dl>
<hr>
<div class="type-signature"><span class="modifiers">public class </span><span class="element-name"><a href="../../../../../src-html/org/apache/juneau/rest/httppart/RequestPathParams.html#line-103">RequestPathParams</a></span>
<span class="extends-implements">extends <a href="https://docs.oracle.com/javase/8/docs/api/java/util/ArrayList.html" title="class or interface in java.util" class="external-link">ArrayList</a>&lt;<a href="RequestPathParam.html" title="class in org.apache.juneau.rest.httppart">RequestPathParam</a>&gt;</span></div>
<div class="block">Represents the path parameters in an HTTP request.
<p>
The <a href="RequestPathParams.html" title="class in org.apache.juneau.rest.httppart"><code>RequestPathParams</code></a> object is the API for accessing the matched variables
and remainder on the URL path.
</p>
<p class='bjava'>
<ja>@RestPost</ja>(...)
<jk>public</jk> Object myMethod(RequestPathParams <jv>path</jv>) {...}
</p>
<h5 class='figure'>Example:</h5>
<p class='bjava'>
<ja>@RestPost</ja>(..., path=<js>"/{foo}/{bar}/{baz}/*"</js>)
<jk>public void</jk> doGet(RequestPathParams <jv>path</jv>) {
<jc>// Example URL: /123/qux/true/quux</jc>
<jk>int</jk> <jv>foo</jv> = <jv>path</jv>.get(<js>"foo"</js>).asInteger().orElse(0); <jc>// =123</jc>
String <jv>bar</jv> = <jv>path</jv>.get(<js>"bar"</js>).orElse(<jk>null</jk>); <jc>// =qux</jc>
<jk>boolean</jk> <jv>baz</jv> = <jv>path</jv>.get(<js>"baz"</js>).asBoolean().orElse(<jk>false</jk>); <jc>// =true</jc>
String <jv>remainder</jv> = <jv>path</jv>.getRemainder(); <jc>// =quux</jc>
}
</p>
<p>
Some important methods on this class are:
</p>
<ul class='javatree'>
<li class='jc'><a href="RequestPathParams.html" title="class in org.apache.juneau.rest.httppart"><code>RequestPathParams</code></a>
<ul class='spaced-list'>
<li>Methods for retrieving path parameters:
<ul class='javatreec'>
<li class='jm'><a href="#contains(java.lang.String)"><code>contains(String)</code></a>
<li class='jm'><a href="#containsAny(java.lang.String...)"><code>containsAny(String...)</code></a>
<li class='jm'><a href="#get(java.lang.Class)"><code>get(Class)</code></a>
<li class='jm'><a href="#get(java.lang.String)"><code>get(String)</code></a>
<li class='jm'><a href="#getAll(java.lang.String)"><code>getAll(String)</code></a>
<li class='jm'><a href="#getFirst(java.lang.String)"><code>getFirst(String)</code></a>
<li class='jm'><a href="#getLast(java.lang.String)"><code>getLast(String)</code></a>
<li class='jm'><a href="#getRemainder()"><code>getRemainder()</code></a>
<li class='jm'><a href="#getRemainderUndecoded()"><code>getRemainderUndecoded()</code></a>
</ul>
<li>Methods overridding path parameters:
<ul class='javatreec'>
<li class='jm'><a href="#add(org.apache.http.NameValuePair...)"><code>add(NameValuePair...)</code></a>
<li class='jm'><a href="#add(java.lang.String,java.lang.Object)"><code>add(String,Object)</code></a>
<li class='jm'><a href="#addDefault(java.util.List)"><code>addDefault(List)</code></a>
<li class='jm'><a href="#addDefault(org.apache.http.NameValuePair...)"><code>addDefault(NameValuePair...)</code></a>
<li class='jm'><a href="#remove(java.lang.String)"><code>remove(String)</code></a>
<li class='jm'><a href="#set(org.apache.http.NameValuePair...)"><code>set(NameValuePair...)</code></a>
<li class='jm'><a href="#set(java.lang.String,java.lang.Object)"><code>set(String,Object)</code></a>
</ul>
<li>Other methods:
<ul class='javatreec'>
<li class='jm'><a href="#copy()"><code>copy()</code></a>
<li class='jm'><a href="https://docs.oracle.com/javase/8/docs/api/java/util/ArrayList.html#isEmpty()" title="class or interface in java.util" class="external-link"><code>isEmpty()</code></a>
</ul>
</ul>
</ul>
<h5 class='section'>See Also:</h5><ul>
<li class='jc'><a href="RequestPathParam.html" title="class in org.apache.juneau.rest.httppart"><code>RequestPathParam</code></a>
<li class='ja'><a href="../../http/annotation/Path.html" title="annotation in org.apache.juneau.http.annotation"><code>Path</code></a>
<li class='link'><a class="doclink" href="../../../../../index.html#jrs.HttpParts">HTTP Parts</a>
</ul></div>
<dl class="notes">
<dt>See Also:</dt>
<dd>
<ul class="see-list">
<li><a href="../../../../../serialized-form.html#org.apache.juneau.rest.httppart.RequestPathParams">Serialized Form</a></li>
</ul>
</dd>
</dl>
</section>
<section class="summary">
<ul class="summary-list">
<!-- =========== FIELD SUMMARY =========== -->
<li>
<section class="field-summary" id="field-summary">
<h2>Field Summary</h2>
<div class="inherited-list">
<h3 id="fields-inherited-from-class-java.util.AbstractList">Fields inherited from class&nbsp;java.util.<a href="https://docs.oracle.com/javase/8/docs/api/java/util/AbstractList.html" title="class or interface in java.util" class="external-link">AbstractList</a></h3>
<code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/AbstractList.html#modCount" title="class or interface in java.util" class="external-link">modCount</a></code></div>
</section>
</li>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<li>
<section class="constructor-summary" id="constructor-summary">
<h2>Constructor Summary</h2>
<div class="caption"><span>Constructors</span></div>
<div class="summary-table two-column-summary">
<div class="table-header col-first">Constructor</div>
<div class="table-header col-last">Description</div>
<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(org.apache.juneau.rest.RestSession,org.apache.juneau.rest.RestRequest,boolean)" class="member-name-link">RequestPathParams</a><wbr>(<a href="../RestSession.html" title="class in org.apache.juneau.rest">RestSession</a>&nbsp;session,
<a href="../RestRequest.html" title="class in org.apache.juneau.rest">RestRequest</a>&nbsp;req,
boolean&nbsp;caseSensitive)</code></div>
<div class="col-last even-row-color">
<div class="block">Constructor.</div>
</div>
</div>
</section>
</li>
<!-- ========== METHOD SUMMARY =========== -->
<li>
<section class="method-summary" id="method-summary">
<h2>Method Summary</h2>
<div id="method-summary-table">
<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div>
<div id="method-summary-table.tabpanel" role="tabpanel">
<div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0">
<div class="table-header col-first">Modifier and Type</div>
<div class="table-header col-second">Method</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="RequestPathParams.html" title="class in org.apache.juneau.rest.httppart">RequestPathParams</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#add(java.lang.String,java.lang.Object)" class="member-name-link">add</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;name,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>&nbsp;value)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Adds a parameter value.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="RequestPathParams.html" title="class in org.apache.juneau.rest.httppart">RequestPathParams</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#add(org.apache.http.NameValuePair...)" class="member-name-link">add</a><wbr>(<a href="https://hc.apache.org/httpcomponents-core-4.4.x/current/httpcore/apidocs/org/apache/http/NameValuePair.html" title="class or interface in org.apache.http" class="external-link">NameValuePair</a>...&nbsp;parameters)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Adds request parameter values.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="RequestPathParams.html" title="class in org.apache.juneau.rest.httppart">RequestPathParams</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#addDefault(java.lang.String,java.lang.String)" class="member-name-link">addDefault</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;name,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;value)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Adds a default entry to the query parameters.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="RequestPathParams.html" title="class in org.apache.juneau.rest.httppart">RequestPathParams</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#addDefault(java.util.List)" class="member-name-link">addDefault</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html" title="class or interface in java.util" class="external-link">List</a>&lt;<a href="https://hc.apache.org/httpcomponents-core-4.4.x/current/httpcore/apidocs/org/apache/http/NameValuePair.html" title="class or interface in org.apache.http" class="external-link">NameValuePair</a>&gt;&nbsp;pairs)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Adds default entries to these parameters.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="RequestPathParams.html" title="class in org.apache.juneau.rest.httppart">RequestPathParams</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#addDefault(org.apache.http.NameValuePair...)" class="member-name-link">addDefault</a><wbr>(<a href="https://hc.apache.org/httpcomponents-core-4.4.x/current/httpcore/apidocs/org/apache/http/NameValuePair.html" title="class or interface in org.apache.http" class="external-link">NameValuePair</a>...&nbsp;pairs)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Adds default entries to these parameters.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="RequestPathParams.html" title="class in org.apache.juneau.rest.httppart">RequestPathParams</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#caseSensitive(boolean)" class="member-name-link">caseSensitive</a><wbr>(boolean&nbsp;value)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Sets case sensitivity for names in this list.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#contains(java.lang.String)" class="member-name-link">contains</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;name)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Returns <jk>true</jk> if the parameters with the specified name is present.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#containsAny(java.lang.String...)" class="member-name-link">containsAny</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>...&nbsp;names)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Returns <jk>true</jk> if the parameter with any of the specified names are present.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="RequestPathParams.html" title="class in org.apache.juneau.rest.httppart">RequestPathParams</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#copy()" class="member-name-link">copy</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Makes a copy of these parameters.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>&lt;T&gt;&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Optional.html" title="class or interface in java.util" class="external-link">Optional</a>&lt;T&gt;</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#get(java.lang.Class)" class="member-name-link">get</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a>&lt;T&gt;&nbsp;type)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Returns the path parameter as the specified bean type.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="RequestPathParam.html" title="class in org.apache.juneau.rest.httppart">RequestPathParam</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#get(java.lang.String)" class="member-name-link">get</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;name)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Returns the last parameter with the specified name.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html" title="class or interface in java.util" class="external-link">List</a>&lt;<a href="RequestPathParam.html" title="class in org.apache.juneau.rest.httppart">RequestPathParam</a>&gt;</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getAll(java.lang.String)" class="member-name-link">getAll</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;name)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Returns all the parameters with the specified name.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="RequestPathParam.html" title="class in org.apache.juneau.rest.httppart">RequestPathParam</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getFirst(java.lang.String)" class="member-name-link">getFirst</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;name)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Returns the first parameter with the specified name.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="RequestPathParam.html" title="class in org.apache.juneau.rest.httppart">RequestPathParam</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getLast(java.lang.String)" class="member-name-link">getLast</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;name)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Returns the last parameter with the specified name.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html" title="class or interface in java.util" class="external-link">List</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&gt;</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getNames()" class="member-name-link">getNames</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Returns all the unique header names in this list.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="RequestPathParam.html" title="class in org.apache.juneau.rest.httppart">RequestPathParam</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getRemainder()" class="member-name-link">getRemainder</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Returns the decoded remainder of the URL following any path pattern matches.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="RequestPathParam.html" title="class in org.apache.juneau.rest.httppart">RequestPathParam</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getRemainderUndecoded()" class="member-name-link">getRemainderUndecoded</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Same as <a href="#getRemainder()"><code>getRemainder()</code></a> but doesn't decode characters.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/stream/Stream.html" title="class or interface in java.util.stream" class="external-link">Stream</a>&lt;<a href="RequestPathParam.html" title="class in org.apache.juneau.rest.httppart">RequestPathParam</a>&gt;</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getSorted()" class="member-name-link">getSorted</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Returns all headers in sorted order.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="RequestPathParams.html" title="class in org.apache.juneau.rest.httppart">RequestPathParams</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#parser(org.apache.juneau.httppart.HttpPartParserSession)" class="member-name-link">parser</a><wbr>(<a href="../../httppart/HttpPartParserSession.html" title="interface in org.apache.juneau.httppart">HttpPartParserSession</a>&nbsp;value)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Sets the parser to use for part values.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="RequestPathParams.html" title="class in org.apache.juneau.rest.httppart">RequestPathParams</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#remove(java.lang.String)" class="member-name-link">remove</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;name)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Remove parameters.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="RequestPathParams.html" title="class in org.apache.juneau.rest.httppart">RequestPathParams</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#set(java.lang.String,java.lang.Object)" class="member-name-link">set</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;name,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>&nbsp;value)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Sets a parameter value.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="RequestPathParams.html" title="class in org.apache.juneau.rest.httppart">RequestPathParams</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#set(org.apache.http.NameValuePair...)" class="member-name-link">set</a><wbr>(<a href="https://hc.apache.org/httpcomponents-core-4.4.x/current/httpcore/apidocs/org/apache/http/NameValuePair.html" title="class or interface in org.apache.http" class="external-link">NameValuePair</a>...&nbsp;parameters)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Sets request header values.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/stream/Stream.html" title="class or interface in java.util.stream" class="external-link">Stream</a>&lt;<a href="RequestPathParam.html" title="class in org.apache.juneau.rest.httppart">RequestPathParam</a>&gt;</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#stream(java.lang.String)" class="member-name-link">stream</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;name)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Returns all headers with the specified name.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="RequestPathParams.html" title="class in org.apache.juneau.rest.httppart">RequestPathParams</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#subset(java.lang.String...)" class="member-name-link">subset</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>...&nbsp;names)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Returns a copy of this object but only with the specified param names copied.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#toString()" class="member-name-link">toString</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">&nbsp;</div>
</div>
</div>
</div>
<div class="inherited-list">
<h3 id="methods-inherited-from-class-java.util.ArrayList">Methods inherited from class&nbsp;java.util.<a href="https://docs.oracle.com/javase/8/docs/api/java/util/ArrayList.html" title="class or interface in java.util" class="external-link">ArrayList</a></h3>
<code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/ArrayList.html#add(int,E)" title="class or interface in java.util" class="external-link">add</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/util/ArrayList.html#add(E)" title="class or interface in java.util" class="external-link">add</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/util/ArrayList.html#addAll(int,java.util.Collection)" title="class or interface in java.util" class="external-link">addAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/util/ArrayList.html#addAll(java.util.Collection)" title="class or interface in java.util" class="external-link">addAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/util/ArrayList.html#clear()" title="class or interface in java.util" class="external-link">clear</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/util/ArrayList.html#clone()" title="class or interface in java.util" class="external-link">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/util/ArrayList.html#contains(java.lang.Object)" title="class or interface in java.util" class="external-link">contains</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/util/ArrayList.html#ensureCapacity(int)" title="class or interface in java.util" class="external-link">ensureCapacity</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/util/ArrayList.html#equals(java.lang.Object)" title="class or interface in java.util" class="external-link">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/util/ArrayList.html#forEach(java.util.function.Consumer)" title="class or interface in java.util" class="external-link">forEach</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/util/ArrayList.html#get(int)" title="class or interface in java.util" class="external-link">get</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/util/ArrayList.html#hashCode()" title="class or interface in java.util" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/util/ArrayList.html#indexOf(java.lang.Object)" title="class or interface in java.util" class="external-link">indexOf</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/util/ArrayList.html#isEmpty()" title="class or interface in java.util" class="external-link">isEmpty</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/util/ArrayList.html#iterator()" title="class or interface in java.util" class="external-link">iterator</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/util/ArrayList.html#lastIndexOf(java.lang.Object)" title="class or interface in java.util" class="external-link">lastIndexOf</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/util/ArrayList.html#listIterator()" title="class or interface in java.util" class="external-link">listIterator</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/util/ArrayList.html#listIterator(int)" title="class or interface in java.util" class="external-link">listIterator</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/util/ArrayList.html#remove(int)" title="class or interface in java.util" class="external-link">remove</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/util/ArrayList.html#remove(java.lang.Object)" title="class or interface in java.util" class="external-link">remove</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/util/ArrayList.html#removeAll(java.util.Collection)" title="class or interface in java.util" class="external-link">removeAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/util/ArrayList.html#removeIf(java.util.function.Predicate)" title="class or interface in java.util" class="external-link">removeIf</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/util/ArrayList.html#removeRange(int,int)" title="class or interface in java.util" class="external-link">removeRange</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/util/ArrayList.html#replaceAll(java.util.function.UnaryOperator)" title="class or interface in java.util" class="external-link">replaceAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/util/ArrayList.html#retainAll(java.util.Collection)" title="class or interface in java.util" class="external-link">retainAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/util/ArrayList.html#set(int,E)" title="class or interface in java.util" class="external-link">set</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/util/ArrayList.html#size()" title="class or interface in java.util" class="external-link">size</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/util/ArrayList.html#sort(java.util.Comparator)" title="class or interface in java.util" class="external-link">sort</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/util/ArrayList.html#spliterator()" title="class or interface in java.util" class="external-link">spliterator</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/util/ArrayList.html#subList(int,int)" title="class or interface in java.util" class="external-link">subList</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/util/ArrayList.html#toArray()" title="class or interface in java.util" class="external-link">toArray</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/util/ArrayList.html#toArray(T%5B%5D)" title="class or interface in java.util" class="external-link">toArray</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/util/ArrayList.html#trimToSize()" title="class or interface in java.util" class="external-link">trimToSize</a></code></div>
<div class="inherited-list">
<h3 id="methods-inherited-from-class-java.util.AbstractCollection">Methods inherited from class&nbsp;java.util.<a href="https://docs.oracle.com/javase/8/docs/api/java/util/AbstractCollection.html" title="class or interface in java.util" class="external-link">AbstractCollection</a></h3>
<code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/AbstractCollection.html#containsAll(java.util.Collection)" title="class or interface in java.util" class="external-link">containsAll</a></code></div>
<div class="inherited-list">
<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3>
<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize()" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div>
<div class="inherited-list">
<h3 id="methods-inherited-from-class-java.util.Collection">Methods inherited from interface&nbsp;java.util.<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html" title="class or interface in java.util" class="external-link">Collection</a></h3>
<code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html#parallelStream()" title="class or interface in java.util" class="external-link">parallelStream</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html#stream()" title="class or interface in java.util" class="external-link">stream</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html#toArray(java.util.function.IntFunction)" title="class or interface in java.util" class="external-link">toArray</a></code></div>
<div class="inherited-list">
<h3 id="methods-inherited-from-class-java.util.List">Methods inherited from interface&nbsp;java.util.<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html" title="class or interface in java.util" class="external-link">List</a></h3>
<code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html#containsAll(java.util.Collection)" title="class or interface in java.util" class="external-link">containsAll</a></code></div>
</section>
</li>
</ul>
</section>
<section class="details">
<ul class="details-list">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<li>
<section class="constructor-details" id="constructor-detail">
<h2>Constructor Details</h2>
<ul class="member-list">
<li>
<section class="detail" id="&lt;init&gt;(org.apache.juneau.rest.RestSession,org.apache.juneau.rest.RestRequest,boolean)">
<h3>RequestPathParams</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="element-name"><a href="../../../../../src-html/org/apache/juneau/rest/httppart/RequestPathParams.html#line-119">RequestPathParams</a></span><wbr><span class="parameters">(<a href="../RestSession.html" title="class in org.apache.juneau.rest">RestSession</a>&nbsp;session,
<a href="../RestRequest.html" title="class in org.apache.juneau.rest">RestRequest</a>&nbsp;req,
boolean&nbsp;caseSensitive)</span></div>
<div class="block">Constructor.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>session</code> - The current HTTP request session.</dd>
<dd><code>req</code> - The current HTTP request.</dd>
<dd><code>caseSensitive</code> - Whether case-sensitive name matching is enabled.</dd>
</dl>
</section>
</li>
</ul>
</section>
</li>
<!-- ============ METHOD DETAIL ========== -->
<li>
<section class="method-details" id="method-detail">
<h2>Method Details</h2>
<ul class="member-list">
<li>
<section class="detail" id="parser(org.apache.juneau.httppart.HttpPartParserSession)">
<h3>parser</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="RequestPathParams.html" title="class in org.apache.juneau.rest.httppart">RequestPathParams</a></span>&nbsp;<span class="element-name"><a href="../../../../../src-html/org/apache/juneau/rest/httppart/RequestPathParams.html#line-171">parser</a></span><wbr><span class="parameters">(<a href="../../httppart/HttpPartParserSession.html" title="interface in org.apache.juneau.httppart">HttpPartParserSession</a>&nbsp;value)</span></div>
<div class="block">Sets the parser to use for part values.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>value</code> - The new value for this setting.</dd>
<dt>Returns:</dt>
<dd>This object.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="caseSensitive(boolean)">
<h3>caseSensitive</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="RequestPathParams.html" title="class in org.apache.juneau.rest.httppart">RequestPathParams</a></span>&nbsp;<span class="element-name"><a href="../../../../../src-html/org/apache/juneau/rest/httppart/RequestPathParams.html#line-183">caseSensitive</a></span><wbr><span class="parameters">(boolean&nbsp;value)</span></div>
<div class="block">Sets case sensitivity for names in this list.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>value</code> - The new value for this setting.</dd>
<dt>Returns:</dt>
<dd>This object (for method chaining).</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="addDefault(java.util.List)">
<h3>addDefault</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="RequestPathParams.html" title="class in org.apache.juneau.rest.httppart">RequestPathParams</a></span>&nbsp;<span class="element-name"><a href="../../../../../src-html/org/apache/juneau/rest/httppart/RequestPathParams.html#line-203">addDefault</a></span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html" title="class or interface in java.util" class="external-link">List</a>&lt;<a href="https://hc.apache.org/httpcomponents-core-4.4.x/current/httpcore/apidocs/org/apache/http/NameValuePair.html" title="class or interface in org.apache.http" class="external-link">NameValuePair</a>&gt;&nbsp;pairs)</span></div>
<div class="block">Adds default entries to these parameters.
<p>
Similar to <a href="#set(java.lang.String,java.lang.Object)"><code>set(String, Object)</code></a> but doesn't override existing values.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>pairs</code> - The default entries.
<br>Can be <jk>null</jk>.</dd>
<dt>Returns:</dt>
<dd>This object.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="addDefault(org.apache.http.NameValuePair...)">
<h3>addDefault</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="RequestPathParams.html" title="class in org.apache.juneau.rest.httppart">RequestPathParams</a></span>&nbsp;<span class="element-name"><a href="../../../../../src-html/org/apache/juneau/rest/httppart/RequestPathParams.html#line-227">addDefault</a></span><wbr><span class="parameters">(<a href="https://hc.apache.org/httpcomponents-core-4.4.x/current/httpcore/apidocs/org/apache/http/NameValuePair.html" title="class or interface in org.apache.http" class="external-link">NameValuePair</a>...&nbsp;pairs)</span></div>
<div class="block">Adds default entries to these parameters.
<p>
Similar to <a href="#set(java.lang.String,java.lang.Object)"><code>set(String, Object)</code></a> but doesn't override existing values.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>pairs</code> - The default entries.
<br>Can be <jk>null</jk>.</dd>
<dt>Returns:</dt>
<dd>This object.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="addDefault(java.lang.String,java.lang.String)">
<h3>addDefault</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="RequestPathParams.html" title="class in org.apache.juneau.rest.httppart">RequestPathParams</a></span>&nbsp;<span class="element-name"><a href="../../../../../src-html/org/apache/juneau/rest/httppart/RequestPathParams.html#line-238">addDefault</a></span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;name,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;value)</span></div>
<div class="block">Adds a default entry to the query parameters.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>name</code> - The name.</dd>
<dd><code>value</code> - The value.</dd>
<dt>Returns:</dt>
<dd>This object.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="add(java.lang.String,java.lang.Object)">
<h3>add</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="RequestPathParams.html" title="class in org.apache.juneau.rest.httppart">RequestPathParams</a></span>&nbsp;<span class="element-name"><a href="../../../../../src-html/org/apache/juneau/rest/httppart/RequestPathParams.html#line-253">add</a></span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;name,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>&nbsp;value)</span></div>
<div class="block">Adds a parameter value.
<p>
Parameter is added to the end.
<br>Existing parameter with the same name are not changed.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>name</code> - The parameter name. Must not be <jk>null</jk>.</dd>
<dd><code>value</code> - The parameter value.</dd>
<dt>Returns:</dt>
<dd>This object.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="add(org.apache.http.NameValuePair...)">
<h3>add</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="RequestPathParams.html" title="class in org.apache.juneau.rest.httppart">RequestPathParams</a></span>&nbsp;<span class="element-name"><a href="../../../../../src-html/org/apache/juneau/rest/httppart/RequestPathParams.html#line-269">add</a></span><wbr><span class="parameters">(<a href="https://hc.apache.org/httpcomponents-core-4.4.x/current/httpcore/apidocs/org/apache/http/NameValuePair.html" title="class or interface in org.apache.http" class="external-link">NameValuePair</a>...&nbsp;parameters)</span></div>
<div class="block">Adds request parameter values.
<p>
Parameters are added to the end.
<br>Existing parameters with the same name are not changed.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>parameters</code> - The parameter objects. Must not be <jk>null</jk>.</dd>
<dt>Returns:</dt>
<dd>This object.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="set(java.lang.String,java.lang.Object)">
<h3>set</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="RequestPathParams.html" title="class in org.apache.juneau.rest.httppart">RequestPathParams</a></span>&nbsp;<span class="element-name"><a href="../../../../../src-html/org/apache/juneau/rest/httppart/RequestPathParams.html#line-291">set</a></span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;name,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>&nbsp;value)</span></div>
<div class="block">Sets a parameter value.
<p>
Parameter is added to the end.
<br>Any previous parameters with the same name are removed.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>name</code> - The parameter name. Must not be <jk>null</jk>.</dd>
<dd><code>value</code> - The parameter value.
<br>Converted to a string using <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link"><code>Object.toString()</code></a>.
<br>Can be <jk>null</jk>.</dd>
<dt>Returns:</dt>
<dd>This object.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="set(org.apache.http.NameValuePair...)">
<h3>set</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="RequestPathParams.html" title="class in org.apache.juneau.rest.httppart">RequestPathParams</a></span>&nbsp;<span class="element-name"><a href="../../../../../src-html/org/apache/juneau/rest/httppart/RequestPathParams.html#line-308">set</a></span><wbr><span class="parameters">(<a href="https://hc.apache.org/httpcomponents-core-4.4.x/current/httpcore/apidocs/org/apache/http/NameValuePair.html" title="class or interface in org.apache.http" class="external-link">NameValuePair</a>...&nbsp;parameters)</span></div>
<div class="block">Sets request header values.
<p>
Parameters are added to the end of the headers.
<br>Any previous parameters with the same name are removed.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>parameters</code> - The parameters to set. Must not be <jk>null</jk> or contain <jk>null</jk>.</dd>
<dt>Returns:</dt>
<dd>This object.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="remove(java.lang.String)">
<h3>remove</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="RequestPathParams.html" title="class in org.apache.juneau.rest.httppart">RequestPathParams</a></span>&nbsp;<span class="element-name"><a href="../../../../../src-html/org/apache/juneau/rest/httppart/RequestPathParams.html#line-323">remove</a></span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;name)</span></div>
<div class="block">Remove parameters.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>name</code> - The parameter name. Must not be <jk>null</jk>.</dd>
<dt>Returns:</dt>
<dd>This object.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="subset(java.lang.String...)">
<h3>subset</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="RequestPathParams.html" title="class in org.apache.juneau.rest.httppart">RequestPathParams</a></span>&nbsp;<span class="element-name"><a href="../../../../../src-html/org/apache/juneau/rest/httppart/RequestPathParams.html#line-335">subset</a></span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>...&nbsp;names)</span></div>
<div class="block">Returns a copy of this object but only with the specified param names copied.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>names</code> - The list to include in the copy.</dd>
<dt>Returns:</dt>
<dd>A new list object.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="contains(java.lang.String)">
<h3>contains</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">boolean</span>&nbsp;<span class="element-name"><a href="../../../../../src-html/org/apache/juneau/rest/httppart/RequestPathParams.html#line-349">contains</a></span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;name)</span></div>
<div class="block">Returns <jk>true</jk> if the parameters with the specified name is present.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>name</code> - The parameter name. Must not be <jk>null</jk>.</dd>
<dt>Returns:</dt>
<dd><jk>true</jk> if the parameters with the specified name is present.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="containsAny(java.lang.String...)">
<h3>containsAny</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">boolean</span>&nbsp;<span class="element-name"><a href="../../../../../src-html/org/apache/juneau/rest/httppart/RequestPathParams.html#line-360">containsAny</a></span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>...&nbsp;names)</span></div>
<div class="block">Returns <jk>true</jk> if the parameter with any of the specified names are present.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>names</code> - The parameter names. Must not be <jk>null</jk>.</dd>
<dt>Returns:</dt>
<dd><jk>true</jk> if the parameter with any of the specified names are present.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getAll(java.lang.String)">
<h3>getAll</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html" title="class or interface in java.util" class="external-link">List</a>&lt;<a href="RequestPathParam.html" title="class in org.apache.juneau.rest.httppart">RequestPathParam</a>&gt;</span>&nbsp;<span class="element-name"><a href="../../../../../src-html/org/apache/juneau/rest/httppart/RequestPathParams.html#line-374">getAll</a></span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;name)</span></div>
<div class="block">Returns all the parameters with the specified name.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>name</code> - The parameter name.</dd>
<dt>Returns:</dt>
<dd>The list of all parameters with the specified name, or an empty list if none are found.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="stream(java.lang.String)">
<h3>stream</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/javase/8/docs/api/java/util/stream/Stream.html" title="class or interface in java.util.stream" class="external-link">Stream</a>&lt;<a href="RequestPathParam.html" title="class in org.apache.juneau.rest.httppart">RequestPathParam</a>&gt;</span>&nbsp;<span class="element-name"><a href="../../../../../src-html/org/apache/juneau/rest/httppart/RequestPathParams.html#line-385">stream</a></span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;name)</span></div>
<div class="block">Returns all headers with the specified name.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>name</code> - The header name.</dd>
<dt>Returns:</dt>
<dd>The stream of all headers with matching names. Never <jk>null</jk>.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getSorted()">
<h3>getSorted</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/javase/8/docs/api/java/util/stream/Stream.html" title="class or interface in java.util.stream" class="external-link">Stream</a>&lt;<a href="RequestPathParam.html" title="class in org.apache.juneau.rest.httppart">RequestPathParam</a>&gt;</span>&nbsp;<span class="element-name"><a href="../../../../../src-html/org/apache/juneau/rest/httppart/RequestPathParams.html#line-394">getSorted</a></span>()</div>
<div class="block">Returns all headers in sorted order.</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>The stream of all headers in sorted order.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getNames()">
<h3>getNames</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html" title="class or interface in java.util" class="external-link">List</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&gt;</span>&nbsp;<span class="element-name"><a href="../../../../../src-html/org/apache/juneau/rest/httppart/RequestPathParams.html#line-407">getNames</a></span>()</div>
<div class="block">Returns all the unique header names in this list.</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>The list of all unique header names in this list.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getFirst(java.lang.String)">
<h3>getFirst</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="RequestPathParam.html" title="class in org.apache.juneau.rest.httppart">RequestPathParam</a></span>&nbsp;<span class="element-name"><a href="../../../../../src-html/org/apache/juneau/rest/httppart/RequestPathParams.html#line-421">getFirst</a></span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;name)</span></div>
<div class="block">Returns the first parameter with the specified name.
<p>
Note that this method never returns <jk>null</jk> and that <a href="RequestHttpPart.html#isPresent()"><code>RequestHttpPart.isPresent()</code></a> can be used
to test for the existence of the parameter.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>name</code> - The parameter name.</dd>
<dt>Returns:</dt>
<dd>The parameter. Never <jk>null</jk>.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getLast(java.lang.String)">
<h3>getLast</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="RequestPathParam.html" title="class in org.apache.juneau.rest.httppart">RequestPathParam</a></span>&nbsp;<span class="element-name"><a href="../../../../../src-html/org/apache/juneau/rest/httppart/RequestPathParams.html#line-436">getLast</a></span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;name)</span></div>
<div class="block">Returns the last parameter with the specified name.
<p>
Note that this method never returns <jk>null</jk> and that <a href="RequestHttpPart.html#isPresent()"><code>RequestHttpPart.isPresent()</code></a> can be used
to test for the existence of the parameter.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>name</code> - The parameter name.</dd>
<dt>Returns:</dt>
<dd>The parameter. Never <jk>null</jk>.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="get(java.lang.String)">
<h3>get</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="RequestPathParam.html" title="class in org.apache.juneau.rest.httppart">RequestPathParam</a></span>&nbsp;<span class="element-name"><a href="../../../../../src-html/org/apache/juneau/rest/httppart/RequestPathParams.html#line-452">get</a></span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;name)</span></div>
<div class="block">Returns the last parameter with the specified name.
<p>
This is equivalent to <a href="#getLast(java.lang.String)"><code>getLast(String)</code></a>.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>name</code> - The parameter name.</dd>
<dt>Returns:</dt>
<dd>The parameter value, or <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Optional.html#empty()" title="class or interface in java.util" class="external-link"><code>Optional.empty()</code></a> if it doesn't exist.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="get(java.lang.Class)">
<h3>get</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="type-parameters">&lt;T&gt;</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Optional.html" title="class or interface in java.util" class="external-link">Optional</a>&lt;T&gt;</span>&nbsp;<span class="element-name"><a href="../../../../../src-html/org/apache/juneau/rest/httppart/RequestPathParams.html#line-478">get</a></span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a>&lt;T&gt;&nbsp;type)</span></div>
<div class="block">Returns the path parameter as the specified bean type.
<p>
Type must have a name specified via the <a href="../../http/annotation/Path.html" title="annotation in org.apache.juneau.http.annotation"><code>Path</code></a> annotation
and a public constructor that takes in either <c>value</c> or <c>name,value</c> as strings.</div>
<dl class="notes">
<dt>Type Parameters:</dt>
<dd><code>T</code> - The bean type to create.</dd>
<dt>Parameters:</dt>
<dd><code>type</code> - The bean type to create.</dd>
<dt>Returns:</dt>
<dd>The bean, never <jk>null</jk>.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="copy()">
<h3>copy</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="RequestPathParams.html" title="class in org.apache.juneau.rest.httppart">RequestPathParams</a></span>&nbsp;<span class="element-name"><a href="../../../../../src-html/org/apache/juneau/rest/httppart/RequestPathParams.html#line-493">copy</a></span>()</div>
<div class="block">Makes a copy of these parameters.</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>A new parameters object.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getRemainder()">
<h3>getRemainder</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="RequestPathParam.html" title="class in org.apache.juneau.rest.httppart">RequestPathParam</a></span>&nbsp;<span class="element-name"><a href="../../../../../src-html/org/apache/juneau/rest/httppart/RequestPathParams.html#line-551">getRemainder</a></span>()</div>
<div class="block">Returns the decoded remainder of the URL following any path pattern matches.
<p>
The behavior of path remainder is shown below given the path pattern "/foo/*":
<table class='styled'>
<tr>
<th>URL</th>
<th>Path Remainder</th>
</tr>
<tr>
<td><c>/foo</c></td>
<td><jk>null</jk></td>
</tr>
<tr>
<td><c>/foo/</c></td>
<td><js>""</js></td>
</tr>
<tr>
<td><c>/foo//</c></td>
<td><js>"/"</js></td>
</tr>
<tr>
<td><c>/foo///</c></td>
<td><js>"//"</js></td>
</tr>
<tr>
<td><c>/foo/a/b</c></td>
<td><js>"a/b"</js></td>
</tr>
<tr>
<td><c>/foo//a/b/</c></td>
<td><js>"/a/b/"</js></td>
</tr>
<tr>
<td><c>/foo/a%2Fb</c></td>
<td><js>"a/b"</js></td>
</tr>
</table>
<h5 class='section'>Example:</h5>
<p class='bjava'>
<jc>// REST method</jc>
<ja>@RestGet</ja>(<js>"/foo/{bar}/*"</js>)
<jk>public</jk> String doGetById(RequestPathParams <jv>path</jv>, <jk>int</jk> <jv>bar</jv>) {
<jk>return</jk> <jv>path</jv>.remainder().orElse(<jk>null</jk>);
}
</p>
<p>
The remainder can also be retrieved by calling <code>get(<js>"/**"</js>)</code>.</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>The path remainder string.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getRemainderUndecoded()">
<h3>getRemainderUndecoded</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="RequestPathParam.html" title="class in org.apache.juneau.rest.httppart">RequestPathParam</a></span>&nbsp;<span class="element-name"><a href="../../../../../src-html/org/apache/juneau/rest/httppart/RequestPathParams.html#line-564">getRemainderUndecoded</a></span>()</div>
<div class="block">Same as <a href="#getRemainder()"><code>getRemainder()</code></a> but doesn't decode characters.
<p>
The undecoded remainder can also be retrieved by calling <code>get(<js>"/*"</js>)</code>.</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>The un-decoded path remainder.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="toString()">
<h3>toString</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span>&nbsp;<span class="element-name"><a href="../../../../../src-html/org/apache/juneau/rest/httppart/RequestPathParams.html#line-574">toString</a></span>()</div>
<dl class="notes">
<dt>Overrides:</dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/AbstractCollection.html#toString()" title="class or interface in java.util" class="external-link">toString</a></code>&nbsp;in class&nbsp;<code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/AbstractCollection.html" title="class or interface in java.util" class="external-link">AbstractCollection</a>&lt;<a href="RequestPathParam.html" title="class in org.apache.juneau.rest.httppart">RequestPathParam</a>&gt;</code></dd>
</dl>
</section>
</li>
</ul>
</section>
</li>
</ul>
</section>
<!-- ========= END OF CLASS DATA ========= -->
</main>
<footer role="contentinfo">
<hr>
<p class="legal-copy"><small>Copyright &#169; 2016&#x2013;2022 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</footer>
</div>
</div>
</body>
</html>