PlotSquared/doc/com/intellectualcrafters/plot/util/StringComparison.html

410 lines
19 KiB
HTML
Raw Normal View History

2014-11-16 11:14:40 +01:00
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="sv">
<head>
<!-- Generated by javadoc (version 1.7.0_67) on Sun Nov 16 11:09:54 CET 2014 -->
<title>StringComparison</title>
<meta name="date" content="2014-11-16">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title = "StringComparison";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!-- -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><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-files/index-1.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../com/intellectualcrafters/plot/util/SetBlockFast.html"
title="class in com.intellectualcrafters.plot.util"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../com/intellectualcrafters/plot/util/UUIDHandler.html"
title="class in com.intellectualcrafters.plot.util"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?com/intellectualcrafters/plot/util/StringComparison.html" target="_top">Frames</a>
</li>
<li><a href="StringComparison.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:&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">
<div class="subTitle">com.intellectualcrafters.plot.util</div>
<h2 title="Class StringComparison" class="title">Class StringComparison</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>com.intellectualcrafters.plot.util.StringComparison</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public class <span class="strong">StringComparison</span>
extends java.lang.Object</pre>
<div class="block">String comparison library</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="overviewSummary" 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">
<td class="colOne"><code><strong><a
href="../../../../com/intellectualcrafters/plot/util/StringComparison.html#StringComparison(java.lang.String,%20java.lang.Object[])">StringComparison</a></strong>(java.lang.String&nbsp;input,
java.lang.Object[]&nbsp;objects)</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="overviewSummary" border="0" cellpadding="3" cellspacing="0"
summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static double</code></td>
<td class="colLast"><code><strong><a
href="../../../../com/intellectualcrafters/plot/util/StringComparison.html#compare(java.lang.String,%20java.lang.String)">compare</a></strong>(java.lang.String&nbsp;s1,
java.lang.String&nbsp;s2)</code>
<div class="block">Compare two strings</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><strong><a
href="../../../../com/intellectualcrafters/plot/util/StringComparison.html#getBestMatch()">getBestMatch</a></strong>()</code>
<div class="block">Get the best match value</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.lang.Object[]</code></td>
<td class="colLast"><code><strong><a
href="../../../../com/intellectualcrafters/plot/util/StringComparison.html#getBestMatchAdvanced()">getBestMatchAdvanced</a></strong>()</code>
<div class="block">Will return both the match number, and the actual match string</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.lang.Object</code></td>
<td class="colLast"><code><strong><a
href="../../../../com/intellectualcrafters/plot/util/StringComparison.html#getMatchObject()">getMatchObject</a></strong>()</code>
<div class="block">Get the object</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static java.lang.String[]</code></td>
<td class="colLast"><code><strong><a
href="../../../../com/intellectualcrafters/plot/util/StringComparison.html#sLetterPair(java.lang.String)">sLetterPair</a></strong>(java.lang.String&nbsp;s)</code>
<div class="block">Get an array containing letter pairs</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static java.util.ArrayList</code></td>
<td class="colLast"><code><strong><a
href="../../../../com/intellectualcrafters/plot/util/StringComparison.html#wLetterPair(java.lang.String)">wLetterPair</a></strong>(java.lang.String&nbsp;s)</code>
<div class="block">Create an ArrayList containing pairs of letters</div>
</td>
</tr>
</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>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait,
wait</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="StringComparison(java.lang.String, java.lang.Object[])">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>StringComparison</h4>
<pre>public&nbsp;StringComparison(java.lang.String&nbsp;input,
java.lang.Object[]&nbsp;objects)</pre>
<div class="block">Constructor</div>
<dl>
<dt><span class="strong">Parameters:</span></dt>
<dd><code>input</code> - Input Base Value</dd>
<dd><code>objects</code> - Objects to compare</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="compare(java.lang.String, java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>compare</h4>
<pre>public static&nbsp;double&nbsp;compare(java.lang.String&nbsp;s1,
java.lang.String&nbsp;s2)</pre>
<div class="block">Compare two strings</div>
<dl>
<dt><span class="strong">Parameters:</span></dt>
<dd><code>s1</code> - String Base</dd>
<dd><code>s2</code> - Object</dd>
<dt><span class="strong">Returns:</span></dt>
<dd>match</dd>
</dl>
</li>
</ul>
<a name="wLetterPair(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>wLetterPair</h4>
<pre>public static&nbsp;java.util.ArrayList&nbsp;wLetterPair(java.lang.String&nbsp;s)</pre>
<div class="block">Create an ArrayList containing pairs of letters</div>
<dl>
<dt><span class="strong">Parameters:</span></dt>
<dd><code>s</code> - string to split</dd>
<dt><span class="strong">Returns:</span></dt>
<dd>ArrayList</dd>
</dl>
</li>
</ul>
<a name="sLetterPair(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>sLetterPair</h4>
<pre>public static&nbsp;java.lang.String[]&nbsp;sLetterPair(java.lang.String&nbsp;s)</pre>
<div class="block">Get an array containing letter pairs</div>
<dl>
<dt><span class="strong">Parameters:</span></dt>
<dd><code>s</code> - string to split</dd>
<dt><span class="strong">Returns:</span></dt>
<dd>Array</dd>
</dl>
</li>
</ul>
<a name="getMatchObject()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMatchObject</h4>
<pre>public&nbsp;java.lang.Object&nbsp;getMatchObject()</pre>
<div class="block">Get the object</div>
<dl>
<dt><span class="strong">Returns:</span></dt>
<dd>match object</dd>
</dl>
</li>
</ul>
<a name="getBestMatch()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getBestMatch</h4>
<pre>public&nbsp;java.lang.String&nbsp;getBestMatch()</pre>
<div class="block">Get the best match value</div>
<dl>
<dt><span class="strong">Returns:</span></dt>
<dd>match value</dd>
</dl>
</li>
</ul>
<a name="getBestMatchAdvanced()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getBestMatchAdvanced</h4>
<pre>public&nbsp;java.lang.Object[]&nbsp;getBestMatchAdvanced()</pre>
<div class="block">Will return both the match number, and the actual match string</div>
<dl>
<dt><span class="strong">Returns:</span></dt>
<dd>object[] containing: double, String</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><a href="#skip-navbar_bottom" title="Skip navigation links"></a><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-files/index-1.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../com/intellectualcrafters/plot/util/SetBlockFast.html"
title="class in com.intellectualcrafters.plot.util"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../com/intellectualcrafters/plot/util/UUIDHandler.html"
title="class in com.intellectualcrafters.plot.util"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?com/intellectualcrafters/plot/util/StringComparison.html" target="_top">Frames</a>
</li>
<li><a href="StringComparison.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:&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>