| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (11.0.10) on Fri Feb 26 09:50:23 CST 2021 --> |
| <title>PathMap (Jetty :: Project 9.4.38.v20210224 API)</title> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <meta name="dc.created" content="2021-02-26"> |
| <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../jquery/jquery-ui.css" title="Style"> |
| <script type="text/javascript" src="../../../../script.js"></script> |
| <script type="text/javascript" src="../../../../jquery/jszip/dist/jszip.min.js"></script> |
| <script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script> |
| <!--[if IE]> |
| <script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script> |
| <![endif]--> |
| <script type="text/javascript" src="../../../../jquery/jquery-3.5.1.js"></script> |
| <script type="text/javascript" src="../../../../jquery/jquery-ui.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="PathMap (Jetty :: Project 9.4.38.v20210224 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var data = {"i0":42,"i1":42,"i2":42,"i3":42,"i4":42,"i5":41,"i6":41,"i7":41,"i8":41,"i9":42,"i10":41,"i11":42,"i12":41}; |
| var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"],32:["t6","Deprecated Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| var pathtoroot = "../../../../"; |
| var useModuleDirectories = false; |
| loadScripts(document, 'script');</script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <header role="banner"> |
| <nav role="navigation"> |
| <div class="fixedNav"> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a id="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a id="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/PathMap.html">Use</a></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" id="allclasses_navbar_top"> |
| <li><a href="../../../../allclasses.html">All Classes</a></li> |
| </ul> |
| <ul class="navListSearch"> |
| <li><label for="search">SEARCH:</label> |
| <input type="text" id="search" value="search" disabled="disabled"> |
| <input type="reset" id="reset" value="reset" disabled="disabled"> |
| </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> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li><a href="#nested.class.summary">Nested</a> | </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 id="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| </div> |
| <div class="navPadding"> </div> |
| <script type="text/javascript"><!-- |
| $('.navPadding').css('padding-top', $('.fixedNav').css("height")); |
| //--> |
| </script> |
| </nav> |
| </header> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <main role="main"> |
| <div class="header"> |
| <div class="subTitle"><span class="packageLabelInType">Package</span> <a href="package-summary.html">org.eclipse.jetty.http</a></div> |
| <h2 title="Class PathMap" class="title">Class PathMap<O></h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li>java.lang.Object</li> |
| <li> |
| <ul class="inheritance"> |
| <li>java.util.AbstractMap<K,​V></li> |
| <li> |
| <ul class="inheritance"> |
| <li>java.util.HashMap<java.lang.String,​O></li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.eclipse.jetty.http.PathMap<O></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt><span class="paramLabel">Type Parameters:</span></dt> |
| <dd><code>O</code> - the Map.Entry value type</dd> |
| </dl> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><code>java.io.Serializable</code>, <code>java.lang.Cloneable</code>, <code>java.util.Map<java.lang.String,​O></code></dd> |
| </dl> |
| <hr> |
| <pre>@Deprecated |
| public class <span class="typeNameLabel">PathMap<O></span> |
| extends java.util.HashMap<java.lang.String,​O></pre> |
| <div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span> |
| <div class="deprecationComment">replaced with <a href="pathmap/PathMappings.html" title="class in org.eclipse.jetty.http.pathmap"><code>PathMappings</code></a> (this class will be removed in Jetty 10)</div> |
| </div> |
| <div class="block">URI path map to Object. |
| <p> |
| This mapping implements the path specification recommended |
| in the 2.2 Servlet API. |
| </p> |
| |
| <p> |
| Path specifications can be of the following forms: |
| </p> |
| <pre> |
| /foo/bar - an exact path specification. |
| /foo/* - a prefix path specification (must end '/*'). |
| *.ext - a suffix path specification. |
| / - the default path specification. |
| "" - the / path specification |
| </pre> |
| |
| Matching is performed in the following order |
| <ol> |
| <li>Exact match.</li> |
| <li>Longest prefix match.</li> |
| <li>Longest suffix match.</li> |
| <li>default.</li> |
| </ol> |
| |
| <p> |
| Multiple path specifications can be mapped by providing a list of |
| specifications. By default this class uses characters ":," as path |
| separators, unless configured differently by calling the static |
| method @see PathMap#setPathSpecSeparators(String) |
| <p> |
| Special characters within paths such as '?� and ';' are not treated specially |
| as it is assumed they would have been either encoded in the original URL or |
| stripped from the path. |
| <p> |
| This class is not synchronized. If concurrent modifications are |
| possible then it should be synchronized at a higher level.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../serialized-form.html#org.eclipse.jetty.http.PathMap">Serialized Form</a></dd> |
| </dl> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ======== NESTED CLASS SUMMARY ======== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="nested.class.summary"> |
| <!-- --> |
| </a> |
| <h3>Nested Class Summary</h3> |
| <table class="memberSummary"> |
| <caption><span>Nested Classes</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colSecond" scope="col">Class</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static class </code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="PathMap.MappedEntry.html" title="class in org.eclipse.jetty.http">PathMap.MappedEntry</a><<a href="PathMap.MappedEntry.html" title="type parameter in PathMap.MappedEntry">O</a>></span></code></th> |
| <td class="colLast"> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span></div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static class </code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="PathMap.PathSet.html" title="class in org.eclipse.jetty.http">PathMap.PathSet</a></span></code></th> |
| <td class="colLast"> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span></div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a id="nested.classes.inherited.from.class.java.util.AbstractMap"> |
| <!-- --> |
| </a> |
| <h3>Nested classes/interfaces inherited from class java.util.AbstractMap</h3> |
| <code>java.util.AbstractMap.SimpleEntry<K extends java.lang.Object,​V extends java.lang.Object>, java.util.AbstractMap.SimpleImmutableEntry<K extends java.lang.Object,​V extends java.lang.Object></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a id="nested.classes.inherited.from.class.java.util.Map"> |
| <!-- --> |
| </a> |
| <h3>Nested classes/interfaces inherited from interface java.util.Map</h3> |
| <code>java.util.Map.Entry<K extends java.lang.Object,​V extends java.lang.Object></code></li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="constructor.summary"> |
| <!-- --> |
| </a> |
| <h3>Constructor Summary</h3> |
| <table class="memberSummary"> |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Constructor</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tr class="altColor"> |
| <th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E()">PathMap</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span></div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(boolean)">PathMap</a></span>​(boolean noDefault)</code></th> |
| <td class="colLast"> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span></div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(int)">PathMap</a></span>​(int capacity)</code></th> |
| <td class="colLast"> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span></div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(java.util.Map)">PathMap</a></span>​(java.util.Map<java.lang.String,​? extends <a href="PathMap.html" title="type parameter in PathMap">O</a>> dictMap)</code></th> |
| <td class="colLast"> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span></div> |
| <div class="block">Construct from dictionary PathMap.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </section> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span><span id="t6" class="tableTab"><span><a href="javascript:show(32);">Deprecated Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colSecond" scope="col">Method</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#clear()">clear</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span></div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#containsMatch(java.lang.String)">containsMatch</a></span>​(java.lang.String path)</code></th> |
| <td class="colLast"> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span></div> |
| <div class="block">Return whether the path matches any entries in the PathMap, |
| excluding the default entry</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code><a href="PathMap.MappedEntry.html" title="class in org.eclipse.jetty.http">PathMap.MappedEntry</a><<a href="PathMap.html" title="type parameter in PathMap">O</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getMatch(java.lang.String)">getMatch</a></span>​(java.lang.String path)</code></th> |
| <td class="colLast"> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span></div> |
| <div class="block">Get the entry mapped by the best specification.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>java.util.List<? extends java.util.Map.Entry<java.lang.String,​<a href="PathMap.html" title="type parameter in PathMap">O</a>>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getMatches(java.lang.String)">getMatches</a></span>​(java.lang.String path)</code></th> |
| <td class="colLast"> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span></div> |
| <div class="block">Get all entries matched by the path.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code><a href="PathMap.html" title="type parameter in PathMap">O</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#match(java.lang.String)">match</a></span>​(java.lang.String path)</code></th> |
| <td class="colLast"> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span></div> |
| <div class="block">Get object matched by the path.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>static boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#match(java.lang.String,java.lang.String)">match</a></span>​(java.lang.String pathSpec, |
| java.lang.String path)</code></th> |
| <td class="colLast"> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span></div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>static boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#match(java.lang.String,java.lang.String,boolean)">match</a></span>​(java.lang.String pathSpec, |
| java.lang.String path, |
| boolean noDefault)</code></th> |
| <td class="colLast"> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span></div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code>static java.lang.String</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#pathInfo(java.lang.String,java.lang.String)">pathInfo</a></span>​(java.lang.String pathSpec, |
| java.lang.String path)</code></th> |
| <td class="colLast"> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span></div> |
| <div class="block">Return the portion of a path that is after a path spec.</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code>static java.lang.String</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#pathMatch(java.lang.String,java.lang.String)">pathMatch</a></span>​(java.lang.String pathSpec, |
| java.lang.String path)</code></th> |
| <td class="colLast"> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span></div> |
| <div class="block">Return the portion of a path that matches a path spec.</div> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code><a href="PathMap.html" title="type parameter in PathMap">O</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#put(java.lang.String,O)">put</a></span>​(java.lang.String pathSpec, |
| <a href="PathMap.html" title="type parameter in PathMap">O</a> object)</code></th> |
| <td class="colLast"> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span></div> |
| <div class="block">Add a single path match to the PathMap.</div> |
| </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code>static java.lang.String</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#relativePath(java.lang.String,java.lang.String,java.lang.String)">relativePath</a></span>​(java.lang.String base, |
| java.lang.String pathSpec, |
| java.lang.String path)</code></th> |
| <td class="colLast"> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span></div> |
| <div class="block">Relative path.</div> |
| </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code><a href="PathMap.html" title="type parameter in PathMap">O</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#remove(java.lang.Object)">remove</a></span>​(java.lang.Object pathSpec)</code></th> |
| <td class="colLast"> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span></div> |
| </td> |
| </tr> |
| <tr id="i12" class="altColor"> |
| <td class="colFirst"><code>static void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setPathSpecSeparators(java.lang.String)">setPathSpecSeparators</a></span>​(java.lang.String s)</code></th> |
| <td class="colLast"> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span></div> |
| <div class="block">Set the path spec separator.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a id="methods.inherited.from.class.java.util.HashMap"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.util.HashMap</h3> |
| <code>clone, compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, entrySet, forEach, get, getOrDefault, isEmpty, keySet, merge, putAll, putIfAbsent, remove, replace, replace, replaceAll, size, values</code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a id="methods.inherited.from.class.java.util.AbstractMap"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.util.AbstractMap</h3> |
| <code>equals, hashCode, toString</code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a id="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.Object</h3> |
| <code>finalize, getClass, notify, notifyAll, wait, wait, wait</code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a id="methods.inherited.from.class.java.util.Map"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface java.util.Map</h3> |
| <code>equals, hashCode</code></li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a id="<init>()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>PathMap</h4> |
| <pre>public PathMap()</pre> |
| <div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span></div> |
| </li> |
| </ul> |
| <a id="<init>(boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>PathMap</h4> |
| <pre>public PathMap​(boolean noDefault)</pre> |
| <div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span></div> |
| </li> |
| </ul> |
| <a id="<init>(int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>PathMap</h4> |
| <pre>public PathMap​(int capacity)</pre> |
| <div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span></div> |
| </li> |
| </ul> |
| <a id="<init>(java.util.Map)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>PathMap</h4> |
| <pre>public PathMap​(java.util.Map<java.lang.String,​? extends <a href="PathMap.html" title="type parameter in PathMap">O</a>> dictMap)</pre> |
| <div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span></div> |
| <div class="block">Construct from dictionary PathMap.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>dictMap</code> - the map representing the dictionary to build this PathMap from</dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| <!-- ============ METHOD DETAIL ========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a id="setPathSpecSeparators(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setPathSpecSeparators</h4> |
| <pre class="methodSignature">public static void setPathSpecSeparators​(java.lang.String s)</pre> |
| <div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span></div> |
| <div class="block">Set the path spec separator. |
| Multiple path specification may be included in a single string |
| if they are separated by the characters set in this string. |
| By default this class uses ":," characters as path separators.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>s</code> - separators</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="put(java.lang.String,java.lang.Object)"> |
| <!-- --> |
| </a><a id="put(java.lang.String,O)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>put</h4> |
| <pre class="methodSignature">public <a href="PathMap.html" title="type parameter in PathMap">O</a> put​(java.lang.String pathSpec, |
| <a href="PathMap.html" title="type parameter in PathMap">O</a> object)</pre> |
| <div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span></div> |
| <div class="block">Add a single path match to the PathMap.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code>put</code> in interface <code>java.util.Map<java.lang.String,​<a href="PathMap.html" title="type parameter in PathMap">O</a>></code></dd> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code>put</code> in class <code>java.util.HashMap<java.lang.String,​<a href="PathMap.html" title="type parameter in PathMap">O</a>></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>pathSpec</code> - The path specification, or comma separated list of |
| path specifications.</dd> |
| <dd><code>object</code> - The object the path maps to</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="match(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>match</h4> |
| <pre class="methodSignature">public <a href="PathMap.html" title="type parameter in PathMap">O</a> match​(java.lang.String path)</pre> |
| <div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span></div> |
| <div class="block">Get object matched by the path.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>path</code> - the path.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Best matched object or null.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getMatch(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getMatch</h4> |
| <pre class="methodSignature">public <a href="PathMap.MappedEntry.html" title="class in org.eclipse.jetty.http">PathMap.MappedEntry</a><<a href="PathMap.html" title="type parameter in PathMap">O</a>> getMatch​(java.lang.String path)</pre> |
| <div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span></div> |
| <div class="block">Get the entry mapped by the best specification.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>path</code> - the path.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Map.Entry of the best matched or null.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getMatches(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getMatches</h4> |
| <pre class="methodSignature">public java.util.List<? extends java.util.Map.Entry<java.lang.String,​<a href="PathMap.html" title="type parameter in PathMap">O</a>>> getMatches​(java.lang.String path)</pre> |
| <div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span></div> |
| <div class="block">Get all entries matched by the path. |
| Best match first.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>path</code> - Path to match</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>List of Map.Entry instances key=pathSpec</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="containsMatch(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>containsMatch</h4> |
| <pre class="methodSignature">public boolean containsMatch​(java.lang.String path)</pre> |
| <div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span></div> |
| <div class="block">Return whether the path matches any entries in the PathMap, |
| excluding the default entry</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>path</code> - Path to match</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Whether the PathMap contains any entries that match this</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="remove(java.lang.Object)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>remove</h4> |
| <pre class="methodSignature">public <a href="PathMap.html" title="type parameter in PathMap">O</a> remove​(java.lang.Object pathSpec)</pre> |
| <div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span></div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code>remove</code> in interface <code>java.util.Map<java.lang.String,​<a href="PathMap.html" title="type parameter in PathMap">O</a>></code></dd> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code>remove</code> in class <code>java.util.HashMap<java.lang.String,​<a href="PathMap.html" title="type parameter in PathMap">O</a>></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="clear()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>clear</h4> |
| <pre class="methodSignature">public void clear()</pre> |
| <div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span></div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code>clear</code> in interface <code>java.util.Map<java.lang.String,​<a href="PathMap.html" title="type parameter in PathMap">O</a>></code></dd> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code>clear</code> in class <code>java.util.HashMap<java.lang.String,​<a href="PathMap.html" title="type parameter in PathMap">O</a>></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="match(java.lang.String,java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>match</h4> |
| <pre class="methodSignature">public static boolean match​(java.lang.String pathSpec, |
| java.lang.String path)</pre> |
| <div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>pathSpec</code> - the path spec</dd> |
| <dd><code>path</code> - the path</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>true if match.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="match(java.lang.String,java.lang.String,boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>match</h4> |
| <pre class="methodSignature">public static boolean match​(java.lang.String pathSpec, |
| java.lang.String path, |
| boolean noDefault)</pre> |
| <div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>pathSpec</code> - the path spec</dd> |
| <dd><code>path</code> - the path</dd> |
| <dd><code>noDefault</code> - true to not handle the default path "/" special, false to allow matcher rules to run</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>true if match.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="pathMatch(java.lang.String,java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>pathMatch</h4> |
| <pre class="methodSignature">public static java.lang.String pathMatch​(java.lang.String pathSpec, |
| java.lang.String path)</pre> |
| <div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span></div> |
| <div class="block">Return the portion of a path that matches a path spec.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>pathSpec</code> - the path spec</dd> |
| <dd><code>path</code> - the path</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>null if no match at all.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="pathInfo(java.lang.String,java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>pathInfo</h4> |
| <pre class="methodSignature">public static java.lang.String pathInfo​(java.lang.String pathSpec, |
| java.lang.String path)</pre> |
| <div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span></div> |
| <div class="block">Return the portion of a path that is after a path spec.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>pathSpec</code> - the path spec</dd> |
| <dd><code>path</code> - the path</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The path info string</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="relativePath(java.lang.String,java.lang.String,java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>relativePath</h4> |
| <pre class="methodSignature">public static java.lang.String relativePath​(java.lang.String base, |
| java.lang.String pathSpec, |
| java.lang.String path)</pre> |
| <div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span></div> |
| <div class="block">Relative path.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>base</code> - The base the path is relative to.</dd> |
| <dd><code>pathSpec</code> - The spec of the path segment to ignore.</dd> |
| <dd><code>path</code> - the additional path</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>base plus path with pathspec removed</dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </div> |
| </div> |
| </main> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <footer role="contentinfo"> |
| <nav role="navigation"> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a id="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a id="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/PathMap.html">Use</a></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" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../allclasses.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> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li><a href="#nested.class.summary">Nested</a> | </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 id="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </nav> |
| <p class="legalCopy"><small>Copyright © 1995–2021 <a href="https://webtide.com">Webtide</a>. All rights reserved.</small></p> |
| </footer> |
| </body> |
| </html> |
