| <!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>RequestPathParam (Apache Juneau 9.0.0)</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="RequestPathParam (Apache Juneau 9.0.0)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10}; |
| var tabs = {65535:["t0","All 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/rest/httppart/RequestHttpPart.html" title="class in org.apache.juneau.rest.httppart"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/juneau/rest/httppart/RequestPathParams.html" title="class in org.apache.juneau.rest.httppart"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/juneau/rest/httppart/RequestPathParam.html" target="_top">Frames</a></li> |
| <li><a href="RequestPathParam.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle">org.apache.juneau.rest.httppart</div> |
| <h2 title="Class RequestPathParam" class="title">Class RequestPathParam</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><a href="../../../../../org/apache/juneau/rest/httppart/RequestHttpPart.html" title="class in org.apache.juneau.rest.httppart">org.apache.juneau.rest.httppart.RequestHttpPart</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.juneau.rest.httppart.RequestPathParam</li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd>org.apache.http.NameValuePair</dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public class <a href="../../../../../src-html/org/apache/juneau/rest/httppart/RequestPathParam.html#line.91">RequestPathParam</a> |
| extends <a href="../../../../../org/apache/juneau/rest/httppart/RequestHttpPart.html" title="class in org.apache.juneau.rest.httppart">RequestHttpPart</a> |
| implements org.apache.http.NameValuePair</pre> |
| <div class="block">Represents a single path parameter on an HTTP request. |
| |
| <p> |
| Typically accessed through the <a href="../../../../../org/apache/juneau/rest/httppart/RequestPathParams.html" title="class in org.apache.juneau.rest.httppart"><code>RequestPathParams</code></a> class. |
| |
| <p> |
| Some important methods on this class are: |
| </p> |
| <ul class='javatree'> |
| <li class='jc'><a href="../../../../../org/apache/juneau/rest/httppart/RequestPathParam.html" title="class in org.apache.juneau.rest.httppart"><code>RequestPathParam</code></a> |
| <ul class='spaced-list'> |
| <li>Methods for retrieving simple string values: |
| <ul class='javatreec'> |
| <li class='jm'><a href="../../../../../org/apache/juneau/rest/httppart/RequestHttpPart.html#asString--"><code>asString()</code></a> |
| <li class='jm'><a href="../../../../../org/apache/juneau/rest/httppart/RequestHttpPart.html#get--"><code>get()</code></a> |
| <li class='jm'><a href="../../../../../org/apache/juneau/rest/httppart/RequestHttpPart.html#isPresent--"><code>isPresent()</code></a> |
| <li class='jm'><a href="../../../../../org/apache/juneau/rest/httppart/RequestHttpPart.html#orElse-java.lang.String-"><code>orElse(String)</code></a> |
| </ul> |
| <li>Methods for retrieving as other common types: |
| <ul class='javatreec'> |
| <li class='jm'><a href="../../../../../org/apache/juneau/rest/httppart/RequestHttpPart.html#asBoolean--"><code>asBoolean()</code></a> |
| <li class='jm'><a href="../../../../../org/apache/juneau/rest/httppart/RequestHttpPart.html#asBooleanPart--"><code>asBooleanPart()</code></a> |
| <li class='jm'><a href="../../../../../org/apache/juneau/rest/httppart/RequestHttpPart.html#asCsvArray--"><code>asCsvArray()</code></a> |
| <li class='jm'><a href="../../../../../org/apache/juneau/rest/httppart/RequestHttpPart.html#asCsvArrayPart--"><code>asCsvArrayPart)</code></a> |
| <li class='jm'><a href="../../../../../org/apache/juneau/rest/httppart/RequestHttpPart.html#asDate--"><code>asDate()</code></a> |
| <li class='jm'><a href="../../../../../org/apache/juneau/rest/httppart/RequestHttpPart.html#asDatePart--"><code>asDatePart()</code></a> |
| <li class='jm'><a href="../../../../../org/apache/juneau/rest/httppart/RequestHttpPart.html#asInteger--"><code>asInteger()</code></a> |
| <li class='jm'><a href="../../../../../org/apache/juneau/rest/httppart/RequestHttpPart.html#asIntegerPart--"><code>asIntegerPart()</code></a> |
| <li class='jm'><a href="../../../../../org/apache/juneau/rest/httppart/RequestHttpPart.html#asLong--"><code>asLong()</code></a> |
| <li class='jm'><a href="../../../../../org/apache/juneau/rest/httppart/RequestHttpPart.html#asLongPart--"><code>asLongPart()</code></a> |
| <li class='jm'><a href="../../../../../org/apache/juneau/rest/httppart/RequestHttpPart.html#asMatcher-java.util.regex.Pattern-"><code>asMatcher(Pattern)</code></a> |
| <li class='jm'><a href="../../../../../org/apache/juneau/rest/httppart/RequestHttpPart.html#asMatcher-java.lang.String-"><code>asMatcher(String)</code></a> |
| <li class='jm'><a href="../../../../../org/apache/juneau/rest/httppart/RequestHttpPart.html#asMatcher-java.lang.String-int-"><code>asMatcher(String,int)</code></a> |
| <li class='jm'><a href="../../../../../org/apache/juneau/rest/httppart/RequestHttpPart.html#asStringPart--"><code>asStringPart()</code></a> |
| <li class='jm'><a href="../../../../../org/apache/juneau/rest/httppart/RequestHttpPart.html#asUriPart--"><code>asUriPart()</code></a> |
| </ul> |
| <li>Methods for retrieving as custom types: |
| <ul class='javatreec'> |
| <li class='jm'><a href="../../../../../org/apache/juneau/rest/httppart/RequestHttpPart.html#as-java.lang.Class-"><code>as(Class)</code></a> |
| <li class='jm'><a href="../../../../../org/apache/juneau/rest/httppart/RequestHttpPart.html#as-org.apache.juneau.ClassMeta-"><code>as(ClassMeta)</code></a> |
| <li class='jm'><a href="../../../../../org/apache/juneau/rest/httppart/RequestHttpPart.html#as-java.lang.reflect.Type-java.lang.reflect.Type...-"><code>as(Type,Type...)</code></a> |
| <li class='jm'><a href="../../../../../org/apache/juneau/rest/httppart/RequestPathParam.html#parser-org.apache.juneau.httppart.HttpPartParserSession-"><code>parser(HttpPartParserSession)</code></a> |
| <li class='jm'><a href="../../../../../org/apache/juneau/rest/httppart/RequestPathParam.html#schema-org.apache.juneau.httppart.HttpPartSchema-"><code>schema(HttpPartSchema)</code></a> |
| </ul> |
| <li>Methods for performing assertion checks: |
| <ul class='javatreec'> |
| <li class='jm'><a href="../../../../../org/apache/juneau/rest/httppart/RequestPathParam.html#assertCsvArray--"><code>assertCsvArray()</code></a> |
| <li class='jm'><a href="../../../../../org/apache/juneau/rest/httppart/RequestPathParam.html#assertDate--"><code>assertDate()</code></a> |
| <li class='jm'><a href="../../../../../org/apache/juneau/rest/httppart/RequestPathParam.html#assertInteger--"><code>assertInteger()</code></a> |
| <li class='jm'><a href="../../../../../org/apache/juneau/rest/httppart/RequestPathParam.html#assertLong--"><code>assertLong()</code></a> |
| <li class='jm'><a href="../../../../../org/apache/juneau/rest/httppart/RequestPathParam.html#assertString--"><code>assertString()</code></a> |
| </ul> |
| <li>Other methods: |
| <ul class='javatreec'> |
| <li class='jm'><a href="../../../../../org/apache/juneau/rest/httppart/RequestHttpPart.html#getName--"><code>getName()</code></a> |
| <li class='jm'><a href="../../../../../org/apache/juneau/rest/httppart/RequestPathParam.html#getValue--"><code>getValue()</code></a> |
| </ul> |
| </ul> |
| |
| <ul class='seealso'> |
| <li class='link'><a class='doclink' href='../../../../../overview-summary.html#juneau-rest-server.jrs.HttpParts'>Overview > juneau-rest-server > HTTP Parts</a> |
| <li class='extlink'><a class='doclink' target='_blank' href='https://github.com/apache/juneau/blob/master/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/httppart/RequestPathParam.java'>Source</a> |
| </ul></div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.summary"> |
| <!-- --> |
| </a> |
| <h3>Constructor Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colOne" scope="col">Constructor and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/httppart/RequestPathParam.html#RequestPathParam-org.apache.juneau.rest.RestRequest-java.lang.String-java.lang.String-">RequestPathParam</a></span>(<a href="../../../../../org/apache/juneau/rest/RestRequest.html" title="class in org.apache.juneau.rest">RestRequest</a> request, |
| <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> name, |
| <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> value)</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"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/juneau/assertions/FluentListAssertion.html" title="class in org.apache.juneau.assertions">FluentListAssertion</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>,<a href="../../../../../org/apache/juneau/rest/httppart/RequestPathParam.html" title="class in org.apache.juneau.rest.httppart">RequestPathParam</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/httppart/RequestPathParam.html#assertCsvArray--">assertCsvArray</a></span>()</code> |
| <div class="block">Provides the ability to perform fluent-style assertions on comma-separated string parameters.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/juneau/assertions/FluentZonedDateTimeAssertion.html" title="class in org.apache.juneau.assertions">FluentZonedDateTimeAssertion</a><<a href="../../../../../org/apache/juneau/rest/httppart/RequestPathParam.html" title="class in org.apache.juneau.rest.httppart">RequestPathParam</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/httppart/RequestPathParam.html#assertDate--">assertDate</a></span>()</code> |
| <div class="block">Provides the ability to perform fluent-style assertions on a date parameter.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/juneau/assertions/FluentIntegerAssertion.html" title="class in org.apache.juneau.assertions">FluentIntegerAssertion</a><<a href="../../../../../org/apache/juneau/rest/httppart/RequestPathParam.html" title="class in org.apache.juneau.rest.httppart">RequestPathParam</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/httppart/RequestPathParam.html#assertInteger--">assertInteger</a></span>()</code> |
| <div class="block">Provides the ability to perform fluent-style assertions on an integer parameter.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/juneau/assertions/FluentLongAssertion.html" title="class in org.apache.juneau.assertions">FluentLongAssertion</a><<a href="../../../../../org/apache/juneau/rest/httppart/RequestPathParam.html" title="class in org.apache.juneau.rest.httppart">RequestPathParam</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/httppart/RequestPathParam.html#assertLong--">assertLong</a></span>()</code> |
| <div class="block">Provides the ability to perform fluent-style assertions on a long parameter.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/juneau/assertions/FluentStringAssertion.html" title="class in org.apache.juneau.assertions">FluentStringAssertion</a><<a href="../../../../../org/apache/juneau/rest/httppart/RequestPathParam.html" title="class in org.apache.juneau.rest.httppart">RequestPathParam</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/httppart/RequestPathParam.html#assertString--">assertString</a></span>()</code> |
| <div class="block">Provides the ability to perform fluent-style assertions on this parameter.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/juneau/rest/httppart/RequestPathParam.html" title="class in org.apache.juneau.rest.httppart">RequestPathParam</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/httppart/RequestPathParam.html#def-java.lang.String-">def</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> def)</code> |
| <div class="block">Sets a default value for this part.</div> |
| </td> |
| </tr> |
| <tr id="i6" 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/rest/httppart/RequestPathParam.html#getValue--">getValue</a></span>()</code> |
| <div class="block">Gets the value of this part.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/juneau/rest/httppart/RequestPathParam.html" title="class in org.apache.juneau.rest.httppart">RequestPathParam</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/httppart/RequestPathParam.html#parser-org.apache.juneau.httppart.HttpPartParserSession-">parser</a></span>(<a href="../../../../../org/apache/juneau/httppart/HttpPartParserSession.html" title="interface in org.apache.juneau.httppart">HttpPartParserSession</a> value)</code> |
| <div class="block">Specifies the part parser to use for this part.</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/juneau/rest/httppart/RequestPathParam.html" title="class in org.apache.juneau.rest.httppart">RequestPathParam</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/httppart/RequestPathParam.html#schema-org.apache.juneau.httppart.HttpPartSchema-">schema</a></span>(<a href="../../../../../org/apache/juneau/httppart/HttpPartSchema.html" title="class in org.apache.juneau.httppart">HttpPartSchema</a> value)</code> |
| <div class="block">Specifies the part schema for this part.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.apache.juneau.rest.httppart.RequestHttpPart"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class org.apache.juneau.rest.httppart.<a href="../../../../../org/apache/juneau/rest/httppart/RequestHttpPart.html" title="class in org.apache.juneau.rest.httppart">RequestHttpPart</a></h3> |
| <code><a href="../../../../../org/apache/juneau/rest/httppart/RequestHttpPart.html#as-java.lang.Class-">as</a>, <a href="../../../../../org/apache/juneau/rest/httppart/RequestHttpPart.html#as-org.apache.juneau.ClassMeta-">as</a>, <a href="../../../../../org/apache/juneau/rest/httppart/RequestHttpPart.html#as-java.lang.reflect.Type-java.lang.reflect.Type...-">as</a>, <a href="../../../../../org/apache/juneau/rest/httppart/RequestHttpPart.html#asBoolean--">asBoolean</a>, <a href="../../../../../org/apache/juneau/rest/httppart/RequestHttpPart.html#asBooleanPart--">asBooleanPart</a>, <a href="../../../../../org/apache/juneau/rest/httppart/RequestHttpPart.html#asCsvArray--">asCsvArray</a>, <a href="../../../../../org/apache/juneau/rest/httppart/RequestHttpPart.html#asCsvArrayPart--">asCsvArrayPart</a>, <a href="../../../../../org/apache/juneau/rest/httppart/RequestHttpPart.html#asDate--">asDate</a>, <a href="../../../../../org/apache/juneau/rest/httppart/RequestHttpPart.html#asDatePart--">asDatePart</a>, <a href="../../../../../org/apache/juneau/rest/httppart/RequestHttpPart.html#asInteger--">asInteger</a>, <a href="../../../../../org/apache/juneau/rest/httppart/RequestHttpPart.html#asIntegerPart--">asIntegerPart</a>, <a href="../../../../../org/apache/juneau/rest/httppart/RequestHttpPart.html#asLong--">asLong</a>, <a href="../../../../../org/apache/juneau/rest/httppart/RequestHttpPart.html#asLongPart--">asLongPart</a>, <a href="../../../../../org/apache/juneau/rest/httppart/RequestHttpPart.html#asMatcher-java.util.regex.Pattern-">asMatcher</a>, <a href="../../../../../org/apache/juneau/rest/httppart/RequestHttpPart.html#asMatcher-java.lang.String-">asMatcher</a>, <a href="../../../../../org/apache/juneau/rest/httppart/RequestHttpPart.html#asMatcher-java.lang.String-int-">asMatcher</a>, <a href="../../../../../org/apache/juneau/rest/httppart/RequestHttpPart.html#asString--">asString</a>, <a href="../../../../../org/apache/juneau/rest/httppart/RequestHttpPart.html#asStringPart--">asStringPart</a>, <a href="../../../../../org/apache/juneau/rest/httppart/RequestHttpPart.html#asUriPart--">asUriPart</a>, <a href="../../../../../org/apache/juneau/rest/httppart/RequestHttpPart.html#get--">get</a>, <a href="../../../../../org/apache/juneau/rest/httppart/RequestHttpPart.html#getName--">getName</a>, <a href="../../../../../org/apache/juneau/rest/httppart/RequestHttpPart.html#getRequest--">getRequest</a>, <a href="../../../../../org/apache/juneau/rest/httppart/RequestHttpPart.html#isPresent--">isPresent</a>, <a href="../../../../../org/apache/juneau/rest/httppart/RequestHttpPart.html#orElse-java.lang.String-">orElse</a>, <a href="../../../../../org/apache/juneau/rest/httppart/RequestHttpPart.html#toString--">toString</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class 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> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.apache.http.NameValuePair"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface org.apache.http.NameValuePair</h3> |
| <code>getName</code></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a name="RequestPathParam-org.apache.juneau.rest.RestRequest-java.lang.String-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>RequestPathParam</h4> |
| <pre>public <a href="../../../../../src-html/org/apache/juneau/rest/httppart/RequestPathParam.html#line.102">RequestPathParam</a>(<a href="../../../../../org/apache/juneau/rest/RestRequest.html" title="class in org.apache.juneau.rest">RestRequest</a> request, |
| <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> name, |
| <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> value)</pre> |
| <div class="block">Constructor.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>request</code> - The request object.</dd> |
| <dd><code>name</code> - The parameter name.</dd> |
| <dd><code>value</code> - The parameter value.</dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="def-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>def</h4> |
| <pre>public <a href="../../../../../org/apache/juneau/rest/httppart/RequestPathParam.html" title="class in org.apache.juneau.rest.httppart">RequestPathParam</a> <a href="../../../../../src-html/org/apache/juneau/rest/httppart/RequestPathParam.html#line.113">def</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> def)</pre> |
| <div class="block">Sets a default value for this part.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>def</code> - The default value.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>This object.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getValue--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getValue</h4> |
| <pre>public <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> <a href="../../../../../src-html/org/apache/juneau/rest/httppart/RequestPathParam.html#line.124">getValue</a>()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../../org/apache/juneau/rest/httppart/RequestHttpPart.html#getValue--">RequestHttpPart</a></code></span></div> |
| <div class="block">Gets the value of this part.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code>getValue</code> in interface <code>org.apache.http.NameValuePair</code></dd> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/apache/juneau/rest/httppart/RequestHttpPart.html#getValue--">getValue</a></code> in class <code><a href="../../../../../org/apache/juneau/rest/httppart/RequestHttpPart.html" title="class in org.apache.juneau.rest.httppart">RequestHttpPart</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The value of this part, may be <jk>null</jk>.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="assertString--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>assertString</h4> |
| <pre>public <a href="../../../../../org/apache/juneau/assertions/FluentStringAssertion.html" title="class in org.apache.juneau.assertions">FluentStringAssertion</a><<a href="../../../../../org/apache/juneau/rest/httppart/RequestPathParam.html" title="class in org.apache.juneau.rest.httppart">RequestPathParam</a>> <a href="../../../../../src-html/org/apache/juneau/rest/httppart/RequestPathParam.html#line.153">assertString</a>()</pre> |
| <div class="block">Provides the ability to perform fluent-style assertions on this parameter. |
| |
| <h5 class='section'>Examples:</h5> |
| <p class='bjava'> |
| <jv>request</jv> |
| .getPathParam(<js>"foo"</js>) |
| .assertString().contains(<js>"bar"</js>); |
| </p> |
| |
| <p> |
| The assertion test returns the original object allowing you to chain multiple requests like so: |
| <p class='bjava'> |
| String <jv>foo</jv> = <jv>request</jv> |
| .getPathParam(<js>"foo"</js>) |
| .assertString().contains(<js>"bar"</js>) |
| .asString().get(); |
| </p></div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>A new fluent assertion object.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="assertInteger--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>assertInteger</h4> |
| <pre>public <a href="../../../../../org/apache/juneau/assertions/FluentIntegerAssertion.html" title="class in org.apache.juneau.assertions">FluentIntegerAssertion</a><<a href="../../../../../org/apache/juneau/rest/httppart/RequestPathParam.html" title="class in org.apache.juneau.rest.httppart">RequestPathParam</a>> <a href="../../../../../src-html/org/apache/juneau/rest/httppart/RequestPathParam.html#line.169">assertInteger</a>()</pre> |
| <div class="block">Provides the ability to perform fluent-style assertions on an integer parameter. |
| |
| <h5 class='section'>Examples:</h5> |
| <p class='bjava'> |
| <jv>request</jv> |
| .getPathParam(<js>"age"</js>) |
| .assertInteger().isGreaterThan(1); |
| </p></div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>A new fluent assertion object.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="assertLong--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>assertLong</h4> |
| <pre>public <a href="../../../../../org/apache/juneau/assertions/FluentLongAssertion.html" title="class in org.apache.juneau.assertions">FluentLongAssertion</a><<a href="../../../../../org/apache/juneau/rest/httppart/RequestPathParam.html" title="class in org.apache.juneau.rest.httppart">RequestPathParam</a>> <a href="../../../../../src-html/org/apache/juneau/rest/httppart/RequestPathParam.html#line.185">assertLong</a>()</pre> |
| <div class="block">Provides the ability to perform fluent-style assertions on a long parameter. |
| |
| <h5 class='section'>Examples:</h5> |
| <p class='bjava'> |
| <jv>request</jv> |
| .getPathParam(<js>"length"</js>) |
| .assertLong().isLessThan(100000); |
| </p></div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>A new fluent assertion object.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="assertDate--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>assertDate</h4> |
| <pre>public <a href="../../../../../org/apache/juneau/assertions/FluentZonedDateTimeAssertion.html" title="class in org.apache.juneau.assertions">FluentZonedDateTimeAssertion</a><<a href="../../../../../org/apache/juneau/rest/httppart/RequestPathParam.html" title="class in org.apache.juneau.rest.httppart">RequestPathParam</a>> <a href="../../../../../src-html/org/apache/juneau/rest/httppart/RequestPathParam.html#line.201">assertDate</a>()</pre> |
| <div class="block">Provides the ability to perform fluent-style assertions on a date parameter. |
| |
| <h5 class='section'>Examples:</h5> |
| <p class='bjava'> |
| <jv>request</jv> |
| .getPathParam(<js>"time"</js>) |
| .assertDate().isAfterNow(); |
| </p></div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>A new fluent assertion object.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="assertCsvArray--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>assertCsvArray</h4> |
| <pre>public <a href="../../../../../org/apache/juneau/assertions/FluentListAssertion.html" title="class in org.apache.juneau.assertions">FluentListAssertion</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>,<a href="../../../../../org/apache/juneau/rest/httppart/RequestPathParam.html" title="class in org.apache.juneau.rest.httppart">RequestPathParam</a>> <a href="../../../../../src-html/org/apache/juneau/rest/httppart/RequestPathParam.html#line.217">assertCsvArray</a>()</pre> |
| <div class="block">Provides the ability to perform fluent-style assertions on comma-separated string parameters. |
| |
| <h5 class='section'>Examples:</h5> |
| <p class='bjava'> |
| <jv>request</jv> |
| .getPathParam(<js>"allow"</js>) |
| .assertCsvArray().contains(<js>"GET"</js>); |
| </p></div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>A new fluent assertion object.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="schema-org.apache.juneau.httppart.HttpPartSchema-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>schema</h4> |
| <pre>public <a href="../../../../../org/apache/juneau/rest/httppart/RequestPathParam.html" title="class in org.apache.juneau.rest.httppart">RequestPathParam</a> <a href="../../../../../src-html/org/apache/juneau/rest/httppart/RequestPathParam.html#line.224">schema</a>(<a href="../../../../../org/apache/juneau/httppart/HttpPartSchema.html" title="class in org.apache.juneau.httppart">HttpPartSchema</a> value)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../../org/apache/juneau/rest/httppart/RequestHttpPart.html#schema-org.apache.juneau.httppart.HttpPartSchema-">RequestHttpPart</a></code></span></div> |
| <div class="block">Specifies the part schema for this part. |
| |
| <p> |
| Used by schema-based part parsers such as <a href="../../../../../org/apache/juneau/oapi/OpenApiParser.html" title="class in org.apache.juneau.oapi"><code>OpenApiParser</code></a>.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="../../../../../org/apache/juneau/rest/httppart/RequestHttpPart.html#schema-org.apache.juneau.httppart.HttpPartSchema-">schema</a></code> in class <code><a href="../../../../../org/apache/juneau/rest/httppart/RequestHttpPart.html" title="class in org.apache.juneau.rest.httppart">RequestHttpPart</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>value</code> - The part schema.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>This object.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="parser-org.apache.juneau.httppart.HttpPartParserSession-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>parser</h4> |
| <pre>public <a href="../../../../../org/apache/juneau/rest/httppart/RequestPathParam.html" title="class in org.apache.juneau.rest.httppart">RequestPathParam</a> <a href="../../../../../src-html/org/apache/juneau/rest/httppart/RequestPathParam.html#line.230">parser</a>(<a href="../../../../../org/apache/juneau/httppart/HttpPartParserSession.html" title="interface in org.apache.juneau.httppart">HttpPartParserSession</a> value)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../../org/apache/juneau/rest/httppart/RequestHttpPart.html#parser-org.apache.juneau.httppart.HttpPartParserSession-">RequestHttpPart</a></code></span></div> |
| <div class="block">Specifies the part parser to use for this part. |
| |
| <p> |
| If not specified, uses the part parser defined on the client by calling <a href="../../../../../org/apache/juneau/rest/RestContext.Builder.html#partParser--"><code>RestContext.Builder.partParser()</code></a>.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="../../../../../org/apache/juneau/rest/httppart/RequestHttpPart.html#parser-org.apache.juneau.httppart.HttpPartParserSession-">parser</a></code> in class <code><a href="../../../../../org/apache/juneau/rest/httppart/RequestHttpPart.html" title="class in org.apache.juneau.rest.httppart">RequestHttpPart</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>value</code> - The new part parser to use for this part. |
| <br>If <jk>null</jk>, <a href="../../../../../org/apache/juneau/httppart/SimplePartParser.html#DEFAULT"><code>SimplePartParser.DEFAULT</code></a> will be used.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>This object.</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/rest/httppart/RequestHttpPart.html" title="class in org.apache.juneau.rest.httppart"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/juneau/rest/httppart/RequestPathParams.html" title="class in org.apache.juneau.rest.httppart"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/juneau/rest/httppart/RequestPathParam.html" target="_top">Frames</a></li> |
| <li><a href="RequestPathParam.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| <p class="legalCopy"><small>Copyright © 2016–2022 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </body> |
| </html> |