Plan/all/com/djrapitops/plan/delivery/web/resolver/request/URIPath.html

372 lines
13 KiB
HTML
Raw Normal View History

2019-08-05 11:13:19 +02:00
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="fi">
<head>
2020-03-21 15:43:05 +01:00
<!-- Generated by javadoc -->
<title>URIPath (Plan 5.1-SNAPSHOT API)</title>
<link rel="stylesheet" type="text/css" href="../../../../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../../../../script.js"></script>
2019-08-05 11:13:19 +02:00
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
2020-03-21 15:43:05 +01:00
parent.document.title="URIPath (Plan 5.1-SNAPSHOT API)";
2019-08-05 11:13:19 +02:00
}
}
catch(err) {
}
//-->
2020-06-21 19:24:04 +02:00
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10};
2019-08-05 11:13:19 +02:00
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">
2020-03-21 15:43:05 +01:00
<li><a href="../../../../../../../overview-summary.html">Overview</a></li>
2019-08-05 11:13:19 +02:00
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
2020-03-21 15:43:05 +01:00
<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>
2019-08-05 11:13:19 +02:00
</ul>
</div>
<div class="subNav">
<ul class="navList">
2020-03-21 15:43:05 +01:00
<li><a href="../../../../../../../com/djrapitops/plan/delivery/web/resolver/request/Request.html" title="class in com.djrapitops.plan.delivery.web.resolver.request"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../../com/djrapitops/plan/delivery/web/resolver/request/URIQuery.html" title="class in com.djrapitops.plan.delivery.web.resolver.request"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
2019-08-05 11:13:19 +02:00
</ul>
<ul class="navList">
2020-03-21 15:43:05 +01:00
<li><a href="../../../../../../../index.html?com/djrapitops/plan/delivery/web/resolver/request/URIPath.html" target="_top">Frames</a></li>
<li><a href="URIPath.html" target="_top">No&nbsp;Frames</a></li>
2019-08-05 11:13:19 +02:00
</ul>
<ul class="navList" id="allclasses_navbar_top">
2020-03-21 15:43:05 +01:00
<li><a href="../../../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
2019-08-05 11:13:19 +02:00
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
2020-03-21 15:43:05 +01:00
<div class="subTitle">com.djrapitops.plan.delivery.web.resolver.request</div>
<h2 title="Class URIPath" class="title">Class URIPath</h2>
2019-08-05 11:13:19 +02:00
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
2020-03-21 15:43:05 +01:00
<li>com.djrapitops.plan.delivery.web.resolver.request.URIPath</li>
2019-08-05 11:13:19 +02:00
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
2020-03-21 15:43:05 +01:00
<pre>public final class <span class="typeNameLabel">URIPath</span>
2019-08-05 11:13:19 +02:00
extends java.lang.Object</pre>
</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">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
2020-03-21 15:43:05 +01:00
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../../com/djrapitops/plan/delivery/web/resolver/request/URIPath.html#URIPath-java.lang.String-">URIPath</a></span>(java.lang.String&nbsp;path)</code>&nbsp;</td>
2019-08-05 11:13:19 +02:00
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
2020-03-21 15:43:05 +01:00
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../com/djrapitops/plan/delivery/web/resolver/request/URIPath.html#asString--">asString</a></span>()</code>
<div class="block">Obtain the full path.</div>
</td>
2019-08-05 11:13:19 +02:00
</tr>
<tr id="i1" class="rowColor">
2020-01-24 11:56:15 +01:00
<td class="colFirst"><code>boolean</code></td>
2020-03-21 15:43:05 +01:00
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../com/djrapitops/plan/delivery/web/resolver/request/URIPath.html#endsWith-java.lang.String-">endsWith</a></span>(java.lang.String&nbsp;suffix)</code>&nbsp;</td>
2020-01-24 11:56:15 +01:00
</tr>
<tr id="i2" class="altColor">
2020-03-21 15:43:05 +01:00
<td class="colFirst"><code>java.util.Optional&lt;java.lang.String&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../com/djrapitops/plan/delivery/web/resolver/request/URIPath.html#getPart-int-">getPart</a></span>(int&nbsp;index)</code>
<div class="block">Obtain part of the path by index of slashes in the URL.</div>
</td>
2019-08-05 11:13:19 +02:00
</tr>
2020-01-24 11:56:15 +01:00
<tr id="i3" class="rowColor">
2020-03-21 15:43:05 +01:00
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../com/djrapitops/plan/delivery/web/resolver/request/URIPath.html#length--">length</a></span>()</code>&nbsp;</td>
2019-08-05 11:13:19 +02:00
</tr>
2020-01-24 11:56:15 +01:00
<tr id="i4" class="altColor">
2020-03-21 15:43:05 +01:00
<td class="colFirst"><code><a href="../../../../../../../com/djrapitops/plan/delivery/web/resolver/request/URIPath.html" title="class in com.djrapitops.plan.delivery.web.resolver.request">URIPath</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../com/djrapitops/plan/delivery/web/resolver/request/URIPath.html#omitFirst--">omitFirst</a></span>()</code>
<div class="block">Immutable modification, removes first part of the path string.</div>
</td>
2019-08-05 11:13:19 +02:00
</tr>
2020-06-21 19:24:04 +02:00
<tr id="i5" class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../com/djrapitops/plan/delivery/web/resolver/request/URIPath.html#toString--">toString</a></span>()</code>&nbsp;</td>
</tr>
2019-08-05 11:13:19 +02:00
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
2020-06-21 19:24:04 +02:00
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait</code></li>
2019-08-05 11:13:19 +02:00
</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>
2020-03-21 15:43:05 +01:00
<a name="URIPath-java.lang.String-">
2019-08-05 11:13:19 +02:00
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
2020-03-21 15:43:05 +01:00
<h4>URIPath</h4>
<pre>public&nbsp;URIPath(java.lang.String&nbsp;path)</pre>
2019-08-05 11:13:19 +02:00
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
2020-03-21 15:43:05 +01:00
<a name="asString--">
2019-08-05 11:13:19 +02:00
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
2020-03-21 15:43:05 +01:00
<h4>asString</h4>
<pre>public&nbsp;java.lang.String&nbsp;asString()</pre>
<div class="block">Obtain the full path.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Example: "/target/path/in/url"</dd>
</dl>
2019-08-05 11:13:19 +02:00
</li>
</ul>
2020-03-21 15:43:05 +01:00
<a name="getPart-int-">
2019-08-05 11:13:19 +02:00
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
2020-03-21 15:43:05 +01:00
<h4>getPart</h4>
<pre>public&nbsp;java.util.Optional&lt;java.lang.String&gt;&nbsp;getPart(int&nbsp;index)</pre>
<div class="block">Obtain part of the path by index of slashes in the URL.
<p>
Example: "/example/path", 0 returns "example"
Example: "/example/path", 1 returns "path"
Example: "/example/path", 2 returns empty optional
Example: "/example/path/", 2 returns ""
Example: "/", 0 returns ""
Example: "/", 1 returns empty optional</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>index</code> - Index from root, eg. /0/1/2/3 etc</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>part after a '/' in the path,</dd>
</dl>
2019-08-05 11:13:19 +02:00
</li>
</ul>
<a name="endsWith-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>endsWith</h4>
<pre>public&nbsp;boolean&nbsp;endsWith(java.lang.String&nbsp;suffix)</pre>
</li>
</ul>
2020-03-21 15:43:05 +01:00
<a name="omitFirst--">
2019-08-05 11:13:19 +02:00
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
2020-03-21 15:43:05 +01:00
<h4>omitFirst</h4>
<pre>public&nbsp;<a href="../../../../../../../com/djrapitops/plan/delivery/web/resolver/request/URIPath.html" title="class in com.djrapitops.plan.delivery.web.resolver.request">URIPath</a>&nbsp;omitFirst()</pre>
<div class="block">Immutable modification, removes first part of the path string.
<p>
Example: URIPath "/example/path" return value of omitFirst URIPath is "/path"
Example: URIPath "/example" return value of omitFirst URIPath is "/"
Example: URIPath "/" return value of omitFirst URIPath is ""</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>new URIPath with first part removed.</dd>
</dl>
2019-08-05 11:13:19 +02:00
</li>
</ul>
2020-03-21 15:43:05 +01:00
<a name="length--">
2019-08-05 11:13:19 +02:00
<!-- -->
</a>
2020-06-21 19:24:04 +02:00
<ul class="blockList">
2019-08-05 11:13:19 +02:00
<li class="blockList">
2020-03-21 15:43:05 +01:00
<h4>length</h4>
<pre>public&nbsp;int&nbsp;length()</pre>
2019-08-05 11:13:19 +02:00
</li>
</ul>
2020-06-21 19:24:04 +02:00
<a name="toString--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>toString</h4>
<pre>public&nbsp;java.lang.String&nbsp;toString()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>toString</code>&nbsp;in class&nbsp;<code>java.lang.Object</code></dd>
</dl>
</li>
</ul>
2019-08-05 11:13:19 +02:00
</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">
2020-03-21 15:43:05 +01:00
<li><a href="../../../../../../../overview-summary.html">Overview</a></li>
2019-08-05 11:13:19 +02:00
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
2020-03-21 15:43:05 +01:00
<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>
2019-08-05 11:13:19 +02:00
</ul>
</div>
<div class="subNav">
<ul class="navList">
2020-03-21 15:43:05 +01:00
<li><a href="../../../../../../../com/djrapitops/plan/delivery/web/resolver/request/Request.html" title="class in com.djrapitops.plan.delivery.web.resolver.request"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../../com/djrapitops/plan/delivery/web/resolver/request/URIQuery.html" title="class in com.djrapitops.plan.delivery.web.resolver.request"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
2019-08-05 11:13:19 +02:00
</ul>
<ul class="navList">
2020-03-21 15:43:05 +01:00
<li><a href="../../../../../../../index.html?com/djrapitops/plan/delivery/web/resolver/request/URIPath.html" target="_top">Frames</a></li>
<li><a href="URIPath.html" target="_top">No&nbsp;Frames</a></li>
2019-08-05 11:13:19 +02:00
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
2020-03-21 15:43:05 +01:00
<li><a href="../../../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
2019-08-05 11:13:19 +02:00
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>