blob: a5e9938fb5fcf8e7b26ff5e810e18beb81983083 [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (11.0.9) on Wed Nov 04 12:15:18 CST 2020 -->
<title>Trie (Jetty :: Project 9.4.34.v20201102 API)</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="dc.created" content="2020-11-04">
<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="Trie (Jetty :: Project 9.4.34.v20201102 API)";
}
}
catch(err) {
}
//-->
var data = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":6,"i9":6,"i10":6,"i11":6,"i12":6,"i13":6,"i14":6};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract 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/Trie.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&nbsp;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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</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">&nbsp;</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>&nbsp;<a href="package-summary.html">org.eclipse.jetty.util</a></div>
<h2 title="Interface Trie" class="title">Interface Trie&lt;V&gt;</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt><span class="paramLabel">Type Parameters:</span></dt>
<dd><code>V</code> - the Trie entry type</dd>
</dl>
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><code><a href="AbstractTrie.html" title="class in org.eclipse.jetty.util">AbstractTrie</a></code>, <code><a href="ArrayTernaryTrie.html" title="class in org.eclipse.jetty.util">ArrayTernaryTrie</a></code>, <code><a href="ArrayTernaryTrie.Growing.html" title="class in org.eclipse.jetty.util">ArrayTernaryTrie.Growing</a></code>, <code><a href="ArrayTrie.html" title="class in org.eclipse.jetty.util">ArrayTrie</a></code>, <code><a href="TreeTrie.html" title="class in org.eclipse.jetty.util">TreeTrie</a></code></dd>
</dl>
<hr>
<pre>public interface <span class="typeNameLabel">Trie&lt;V&gt;</span></pre>
<div class="block">A Trie String lookup data structure.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== 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">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</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">&nbsp;</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="Trie.html" title="type parameter in Trie">V</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#get(java.lang.String)">get</a></span>&#8203;(java.lang.String&nbsp;s)</code></th>
<td class="colLast">
<div class="block">Get an exact match from a String key</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="Trie.html" title="type parameter in Trie">V</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#get(java.lang.String,int,int)">get</a></span>&#8203;(java.lang.String&nbsp;s,
int&nbsp;offset,
int&nbsp;len)</code></th>
<td class="colLast">
<div class="block">Get an exact match from a String key</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="Trie.html" title="type parameter in Trie">V</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#get(java.nio.ByteBuffer)">get</a></span>&#8203;(java.nio.ByteBuffer&nbsp;b)</code></th>
<td class="colLast">
<div class="block">Get an exact match from a segment of a ByteBuufer as key</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code><a href="Trie.html" title="type parameter in Trie">V</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#get(java.nio.ByteBuffer,int,int)">get</a></span>&#8203;(java.nio.ByteBuffer&nbsp;b,
int&nbsp;offset,
int&nbsp;len)</code></th>
<td class="colLast">
<div class="block">Get an exact match from a segment of a ByteBuufer as key</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code><a href="Trie.html" title="type parameter in Trie">V</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getBest(byte%5B%5D,int,int)">getBest</a></span>&#8203;(byte[]&nbsp;b,
int&nbsp;offset,
int&nbsp;len)</code></th>
<td class="colLast">
<div class="block">Get the best match from key in a byte array.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code><a href="Trie.html" title="type parameter in Trie">V</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getBest(java.lang.String)">getBest</a></span>&#8203;(java.lang.String&nbsp;s)</code></th>
<td class="colLast">
<div class="block">Get the best match from key in a String.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code><a href="Trie.html" title="type parameter in Trie">V</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getBest(java.lang.String,int,int)">getBest</a></span>&#8203;(java.lang.String&nbsp;s,
int&nbsp;offset,
int&nbsp;len)</code></th>
<td class="colLast">
<div class="block">Get the best match from key in a String.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code><a href="Trie.html" title="type parameter in Trie">V</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getBest(java.nio.ByteBuffer,int,int)">getBest</a></span>&#8203;(java.nio.ByteBuffer&nbsp;b,
int&nbsp;offset,
int&nbsp;len)</code></th>
<td class="colLast">
<div class="block">Get the best match from key in a byte buffer.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isCaseInsensitive()">isCaseInsensitive</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isFull()">isFull</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>java.util.Set&lt;java.lang.String&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#keySet()">keySet</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#put(java.lang.String,V)">put</a></span>&#8203;(java.lang.String&nbsp;s,
<a href="Trie.html" title="type parameter in Trie">V</a>&nbsp;v)</code></th>
<td class="colLast">
<div class="block">Put an entry into the Trie</div>
</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#put(V)">put</a></span>&#8203;(<a href="Trie.html" title="type parameter in Trie">V</a>&nbsp;v)</code></th>
<td class="colLast">
<div class="block">Put a value as both a key and a value.</div>
</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code><a href="Trie.html" title="type parameter in Trie">V</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#remove(java.lang.String)">remove</a></span>&#8203;(java.lang.String&nbsp;s)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
</table>
</li>
</ul>
</section>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a id="put(java.lang.String,java.lang.Object)">
<!-- -->
</a><a id="put(java.lang.String,V)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>put</h4>
<pre class="methodSignature">boolean&nbsp;put&#8203;(java.lang.String&nbsp;s,
<a href="Trie.html" title="type parameter in Trie">V</a>&nbsp;v)</pre>
<div class="block">Put an entry into the Trie</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>s</code> - The key for the entry</dd>
<dd><code>v</code> - The value of the entry</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>True if the Trie had capacity to add the field.</dd>
</dl>
</li>
</ul>
<a id="put(java.lang.Object)">
<!-- -->
</a><a id="put(V)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>put</h4>
<pre class="methodSignature">boolean&nbsp;put&#8203;(<a href="Trie.html" title="type parameter in Trie">V</a>&nbsp;v)</pre>
<div class="block">Put a value as both a key and a value.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>v</code> - The value and key</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>True if the Trie had capacity to add the field.</dd>
</dl>
</li>
</ul>
<a id="remove(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>remove</h4>
<pre class="methodSignature"><a href="Trie.html" title="type parameter in Trie">V</a>&nbsp;remove&#8203;(java.lang.String&nbsp;s)</pre>
</li>
</ul>
<a id="get(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>get</h4>
<pre class="methodSignature"><a href="Trie.html" title="type parameter in Trie">V</a>&nbsp;get&#8203;(java.lang.String&nbsp;s)</pre>
<div class="block">Get an exact match from a String key</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>s</code> - The key</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the value for the string key</dd>
</dl>
</li>
</ul>
<a id="get(java.lang.String,int,int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>get</h4>
<pre class="methodSignature"><a href="Trie.html" title="type parameter in Trie">V</a>&nbsp;get&#8203;(java.lang.String&nbsp;s,
int&nbsp;offset,
int&nbsp;len)</pre>
<div class="block">Get an exact match from a String key</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>s</code> - The key</dd>
<dd><code>offset</code> - The offset within the string of the key</dd>
<dd><code>len</code> - the length of the key</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the value for the string / offset / length</dd>
</dl>
</li>
</ul>
<a id="get(java.nio.ByteBuffer)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>get</h4>
<pre class="methodSignature"><a href="Trie.html" title="type parameter in Trie">V</a>&nbsp;get&#8203;(java.nio.ByteBuffer&nbsp;b)</pre>
<div class="block">Get an exact match from a segment of a ByteBuufer as key</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>b</code> - The buffer</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The value or null if not found</dd>
</dl>
</li>
</ul>
<a id="get(java.nio.ByteBuffer,int,int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>get</h4>
<pre class="methodSignature"><a href="Trie.html" title="type parameter in Trie">V</a>&nbsp;get&#8203;(java.nio.ByteBuffer&nbsp;b,
int&nbsp;offset,
int&nbsp;len)</pre>
<div class="block">Get an exact match from a segment of a ByteBuufer as key</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>b</code> - The buffer</dd>
<dd><code>offset</code> - The offset within the buffer of the key</dd>
<dd><code>len</code> - the length of the key</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The value or null if not found</dd>
</dl>
</li>
</ul>
<a id="getBest(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getBest</h4>
<pre class="methodSignature"><a href="Trie.html" title="type parameter in Trie">V</a>&nbsp;getBest&#8203;(java.lang.String&nbsp;s)</pre>
<div class="block">Get the best match from key in a String.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>s</code> - The string</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The value or null if not found</dd>
</dl>
</li>
</ul>
<a id="getBest(java.lang.String,int,int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getBest</h4>
<pre class="methodSignature"><a href="Trie.html" title="type parameter in Trie">V</a>&nbsp;getBest&#8203;(java.lang.String&nbsp;s,
int&nbsp;offset,
int&nbsp;len)</pre>
<div class="block">Get the best match from key in a String.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>s</code> - The string</dd>
<dd><code>offset</code> - The offset within the string of the key</dd>
<dd><code>len</code> - the length of the key</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The value or null if not found</dd>
</dl>
</li>
</ul>
<a id="getBest(byte[],int,int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getBest</h4>
<pre class="methodSignature"><a href="Trie.html" title="type parameter in Trie">V</a>&nbsp;getBest&#8203;(byte[]&nbsp;b,
int&nbsp;offset,
int&nbsp;len)</pre>
<div class="block">Get the best match from key in a byte array.
The key is assumed to by ISO_8859_1 characters.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>b</code> - The buffer</dd>
<dd><code>offset</code> - The offset within the array of the key</dd>
<dd><code>len</code> - the length of the key</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The value or null if not found</dd>
</dl>
</li>
</ul>
<a id="getBest(java.nio.ByteBuffer,int,int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getBest</h4>
<pre class="methodSignature"><a href="Trie.html" title="type parameter in Trie">V</a>&nbsp;getBest&#8203;(java.nio.ByteBuffer&nbsp;b,
int&nbsp;offset,
int&nbsp;len)</pre>
<div class="block">Get the best match from key in a byte buffer.
The key is assumed to by ISO_8859_1 characters.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>b</code> - The buffer</dd>
<dd><code>offset</code> - The offset within the buffer of the key</dd>
<dd><code>len</code> - the length of the key</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The value or null if not found</dd>
</dl>
</li>
</ul>
<a id="keySet()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>keySet</h4>
<pre class="methodSignature">java.util.Set&lt;java.lang.String&gt;&nbsp;keySet()</pre>
</li>
</ul>
<a id="isFull()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isFull</h4>
<pre class="methodSignature">boolean&nbsp;isFull()</pre>
</li>
</ul>
<a id="isCaseInsensitive()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isCaseInsensitive</h4>
<pre class="methodSignature">boolean&nbsp;isCaseInsensitive()</pre>
</li>
</ul>
<a id="clear()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>clear</h4>
<pre class="methodSignature">void&nbsp;clear()</pre>
</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/Trie.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&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</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 &#169; 1995&#x2013;2020 <a href="https://webtide.com">Webtide</a>. All rights reserved.</small></p>
</footer>
</body>
</html>