diff options
Diffstat (limited to 'docs/apidocs/index-all.html')
| -rw-r--r-- | docs/apidocs/index-all.html | 82 |
1 files changed, 59 insertions, 23 deletions
diff --git a/docs/apidocs/index-all.html b/docs/apidocs/index-all.html index f36f567..5aaebcc 100644 --- a/docs/apidocs/index-all.html +++ b/docs/apidocs/index-all.html @@ -2,10 +2,10 @@ <!-- NewPage --> <html lang="en"> <head> -<!-- Generated by javadoc (1.8.0_121) on Tue Jul 02 17:00:29 EDT 2019 --> +<!-- Generated by javadoc (1.8.0_121) on Mon Sep 09 20:13:18 EDT 2019 --> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> -<title>Index (everge 1.0-SNAPSHOT API)</title> -<meta name="date" content="2019-07-02"> +<title>Index (everge 0.2.0 API)</title> +<meta name="date" content="2019-09-09"> <link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style"> <script type="text/javascript" src="script.js"></script> </head> @@ -13,7 +13,7 @@ <script type="text/javascript"><!-- try { if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="Index (everge 1.0-SNAPSHOT API)"; + parent.document.title="Index (everge 0.2.0 API)"; } } catch(err) { @@ -98,6 +98,18 @@ </a> <h2 class="title">B</h2> <dl> +<dt><a href="bjc/everge/BadReplParse.html" title="class in bjc.everge"><span class="typeNameLink">BadReplParse</span></a> - Exception in <a href="bjc/everge/package-summary.html">bjc.everge</a></dt> +<dd> +<div class="block">Exception thrown when ReplPair parsing fails</div> +</dd> +<dt><span class="memberNameLink"><a href="bjc/everge/BadReplParse.html#BadReplParse-java.lang.String-">BadReplParse(String)</a></span> - Constructor for exception bjc.everge.<a href="bjc/everge/BadReplParse.html" title="class in bjc.everge">BadReplParse</a></dt> +<dd> +<div class="block">Create a new exception for ReplPair parsing failing.</div> +</dd> +<dt><span class="memberNameLink"><a href="bjc/everge/BadReplParse.html#BadReplParse-java.lang.String-java.util.List-">BadReplParse(String, List<ReplError>)</a></span> - Constructor for exception bjc.everge.<a href="bjc/everge/BadReplParse.html" title="class in bjc.everge">BadReplParse</a></dt> +<dd> +<div class="block">Create a new exception for ReplPair parsing failing.</div> +</dd> <dt><a href="bjc/everge/package-summary.html">bjc.everge</a> - package bjc.everge</dt> <dd> </dd> </dl> @@ -210,17 +222,21 @@ <dd> </dd> <dt><span class="memberNameLink"><a href="bjc/everge/ReplPair.html#equals-java.lang.Object-">equals(Object)</a></span> - Method in class bjc.everge.<a href="bjc/everge/ReplPair.html" title="class in bjc.everge">ReplPair</a></dt> <dd> </dd> -<dt><span class="memberNameLink"><a href="bjc/everge/ReplParseException.html#errs">errs</a></span> - Variable in exception bjc.everge.<a href="bjc/everge/ReplParseException.html" title="class in bjc.everge">ReplParseException</a></dt> -<dd> </dd> +<dt><span class="memberNameLink"><a href="bjc/everge/BadReplParse.html#errs">errs</a></span> - Variable in exception bjc.everge.<a href="bjc/everge/BadReplParse.html" title="class in bjc.everge">BadReplParse</a></dt> +<dd> +<div class="block">The errors that were encountered during parsing.</div> +</dd> <dt><span class="memberNameLink"><a href="bjc/everge/Everge.html#errStream">errStream</a></span> - Variable in class bjc.everge.<a href="bjc/everge/Everge.html" title="class in bjc.everge">Everge</a></dt> <dd> <div class="block">Stream to use for error output.</div> </dd> <dt><span class="memberNameLink"><a href="bjc/everge/ReplOpts.html#errStream">errStream</a></span> - Variable in class bjc.everge.<a href="bjc/everge/ReplOpts.html" title="class in bjc.everge">ReplOpts</a></dt> -<dd> </dd> +<dd> +<div class="block">The stream to print error output on.</div> +</dd> <dt><span class="memberNameLink"><a href="bjc/everge/StringUtils.html#escapeSplit-java.lang.String-java.lang.String-java.lang.String-">escapeSplit(String, String, String)</a></span> - Static method in class bjc.everge.<a href="bjc/everge/StringUtils.html" title="class in bjc.everge">StringUtils</a></dt> <dd> -<div class="block">Split a string on every occurance of a string not preceeded by an escape.</div> +<div class="block">Split a string on every occurrence of a string not preceded by an escape.</div> </dd> <dt><a href="bjc/everge/Everge.html" title="class in bjc.everge"><span class="typeNameLink">Everge</span></a> - Class in <a href="bjc/everge/package-summary.html">bjc.everge</a></dt> <dd> @@ -243,7 +259,9 @@ <div class="block">The string to look for.</div> </dd> <dt><span class="memberNameLink"><a href="bjc/everge/ReplSet.html#fromFile-java.lang.String-">fromFile(String)</a></span> - Static method in class bjc.everge.<a href="bjc/everge/ReplSet.html" title="class in bjc.everge">ReplSet</a></dt> -<dd> </dd> +<dd> +<div class="block">Load a ReplSet from a file.</div> +</dd> </dl> <a name="I:G"> <!-- --> @@ -258,6 +276,10 @@ <dd> <div class="block">Get the value.</div> </dd> +<dt><span class="memberNameLink"><a href="bjc/everge/ReplPair.html#guard">guard</a></span> - Variable in class bjc.everge.<a href="bjc/everge/ReplPair.html" title="class in bjc.everge">ReplPair</a></dt> +<dd> +<div class="block">The guard for this replacement.</div> +</dd> </dl> <a name="I:H"> <!-- --> @@ -305,7 +327,9 @@ <div class="block">Enable debug info.</div> </dd> <dt><span class="memberNameLink"><a href="bjc/everge/StringUtils.html#isDebug">isDebug</a></span> - Static variable in class bjc.everge.<a href="bjc/everge/StringUtils.html" title="class in bjc.everge">StringUtils</a></dt> -<dd> </dd> +<dd> +<div class="block">Is the class in debug mode or not?</div> +</dd> <dt><span class="memberNameLink"><a href="bjc/everge/ReplOpts.html#isPerf">isPerf</a></span> - Variable in class bjc.everge.<a href="bjc/everge/ReplOpts.html" title="class in bjc.everge">ReplOpts</a></dt> <dd> <div class="block">Enable performance info.</div> @@ -367,7 +391,9 @@ <div class="block">Stream to use for normal output.</div> </dd> <dt><span class="memberNameLink"><a href="bjc/everge/ReplOpts.html#outStream">outStream</a></span> - Variable in class bjc.everge.<a href="bjc/everge/ReplOpts.html" title="class in bjc.everge">ReplOpts</a></dt> -<dd> </dd> +<dd> +<div class="block">The stream to print normal output on.</div> +</dd> </dl> <a name="I:P"> <!-- --> @@ -481,12 +507,6 @@ <dd> <div class="block">Create a new replacement pair with a set priority and name.</div> </dd> -<dt><a href="bjc/everge/ReplParseException.html" title="class in bjc.everge"><span class="typeNameLink">ReplParseException</span></a> - Exception in <a href="bjc/everge/package-summary.html">bjc.everge</a></dt> -<dd> </dd> -<dt><span class="memberNameLink"><a href="bjc/everge/ReplParseException.html#ReplParseException-java.lang.String-">ReplParseException(String)</a></span> - Constructor for exception bjc.everge.<a href="bjc/everge/ReplParseException.html" title="class in bjc.everge">ReplParseException</a></dt> -<dd> </dd> -<dt><span class="memberNameLink"><a href="bjc/everge/ReplParseException.html#ReplParseException-java.lang.String-java.util.List-">ReplParseException(String, List<ReplError>)</a></span> - Constructor for exception bjc.everge.<a href="bjc/everge/ReplParseException.html" title="class in bjc.everge">ReplParseException</a></dt> -<dd> </dd> <dt><a href="bjc/everge/ReplSet.html" title="class in bjc.everge"><span class="typeNameLink">ReplSet</span></a> - Class in <a href="bjc/everge/package-summary.html">bjc.everge</a></dt> <dd> <div class="block">A set of ReplPairs, kept together for easy use</div> @@ -506,7 +526,17 @@ <h2 class="title">S</h2> <dl> <dt><span class="memberNameLink"><a href="bjc/everge/IntHolder.html#set-int-">set(int)</a></span> - Method in class bjc.everge.<a href="bjc/everge/IntHolder.html" title="class in bjc.everge">IntHolder</a></dt> -<dd> </dd> +<dd> +<div class="block">Set the value.</div> +</dd> +<dt><span class="memberNameLink"><a href="bjc/everge/StringUtils.html#sliceString-java.lang.String-int-int-">sliceString(String, int, int)</a></span> - Static method in class bjc.everge.<a href="bjc/everge/StringUtils.html" title="class in bjc.everge">StringUtils</a></dt> +<dd> +<div class="block">Slice a substring out of another string.</div> +</dd> +<dt><span class="memberNameLink"><a href="bjc/everge/StringUtils.html#sliceStringL-java.lang.String-int-int-">sliceStringL(String, int, int)</a></span> - Static method in class bjc.everge.<a href="bjc/everge/StringUtils.html" title="class in bjc.everge">StringUtils</a></dt> +<dd> +<div class="block">Slice a substring out of another string.</div> +</dd> <dt><a href="bjc/everge/StageStatus.html" title="enum in bjc.everge"><span class="typeNameLink">StageStatus</span></a> - Enum in <a href="bjc/everge/package-summary.html">bjc.everge</a></dt> <dd> <div class="block">Possible statuses of pairs with respect to exporting.</div> @@ -527,11 +557,19 @@ </a> <h2 class="title">T</h2> <dl> +<dt><span class="memberNameLink"><a href="bjc/everge/BadReplParse.html#toPrintString--">toPrintString()</a></span> - Method in exception bjc.everge.<a href="bjc/everge/BadReplParse.html" title="class in bjc.everge">BadReplParse</a></dt> +<dd> +<div class="block">Convert the exception to a printable format.</div> +</dd> <dt><span class="memberNameLink"><a href="bjc/everge/ReplError.html#toPrintString--">toPrintString()</a></span> - Method in class bjc.everge.<a href="bjc/everge/ReplError.html" title="class in bjc.everge">ReplError</a></dt> -<dd> </dd> +<dd> +<div class="block">Convert the error to a printable string.</div> +</dd> <dt><span class="memberNameLink"><a href="bjc/everge/ReplError.html#toPrintString-java.lang.String-">toPrintString(String)</a></span> - Method in class bjc.everge.<a href="bjc/everge/ReplError.html" title="class in bjc.everge">ReplError</a></dt> -<dd> </dd> -<dt><span class="memberNameLink"><a href="bjc/everge/ReplParseException.html#toPrintString--">toPrintString()</a></span> - Method in exception bjc.everge.<a href="bjc/everge/ReplParseException.html" title="class in bjc.everge">ReplParseException</a></dt> +<dd> +<div class="block">Convert the error to a printable string, with a custom header.</div> +</dd> +<dt><span class="memberNameLink"><a href="bjc/everge/BadReplParse.html#toString--">toString()</a></span> - Method in exception bjc.everge.<a href="bjc/everge/BadReplParse.html" title="class in bjc.everge">BadReplParse</a></dt> <dd> </dd> <dt><span class="memberNameLink"><a href="bjc/everge/ControlledString.Control.html#toString--">toString()</a></span> - Method in class bjc.everge.<a href="bjc/everge/ControlledString.Control.html" title="class in bjc.everge">ControlledString.Control</a></dt> <dd> </dd> @@ -541,8 +579,6 @@ <dd> </dd> <dt><span class="memberNameLink"><a href="bjc/everge/ReplPair.html#toString--">toString()</a></span> - Method in class bjc.everge.<a href="bjc/everge/ReplPair.html" title="class in bjc.everge">ReplPair</a></dt> <dd> </dd> -<dt><span class="memberNameLink"><a href="bjc/everge/ReplParseException.html#toString--">toString()</a></span> - Method in exception bjc.everge.<a href="bjc/everge/ReplParseException.html" title="class in bjc.everge">ReplParseException</a></dt> -<dd> </dd> <dt><span class="memberNameLink"><a href="bjc/everge/ReplError.html#txt">txt</a></span> - Variable in class bjc.everge.<a href="bjc/everge/ReplError.html" title="class in bjc.everge">ReplError</a></dt> <dd> <div class="block">The text of the line we errored on.</div> |