diff options
Diffstat (limited to 'docs/apidocs/index-all.html')
| -rw-r--r-- | docs/apidocs/index-all.html | 103 |
1 files changed, 98 insertions, 5 deletions
diff --git a/docs/apidocs/index-all.html b/docs/apidocs/index-all.html index 4fd4ea3..d210da7 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 Fri Jun 21 16:36:46 EDT 2019 --> +<!-- Generated by javadoc (1.8.0_121) on Mon Jun 24 20:47:44 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-06-21"> +<meta name="date" content="2019-06-24"> <link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style"> <script type="text/javascript" src="script.js"></script> </head> @@ -69,13 +69,29 @@ <!-- --> </a></div> <!-- ========= END OF TOP NAVBAR ========= --> -<div class="contentContainer"><a href="#I:A">A</a> <a href="#I:B">B</a> <a href="#I:C">C</a> <a href="#I:D">D</a> <a href="#I:E">E</a> <a href="#I:F">F</a> <a href="#I:G">G</a> <a href="#I:I">I</a> <a href="#I:L">L</a> <a href="#I:M">M</a> <a href="#I:N">N</a> <a href="#I:O">O</a> <a href="#I:P">P</a> <a href="#I:R">R</a> <a href="#I:S">S</a> <a href="#I:T">T</a> <a href="#I:V">V</a> <a name="I:A"> +<div class="contentContainer"><a href="#I:A">A</a> <a href="#I:B">B</a> <a href="#I:C">C</a> <a href="#I:D">D</a> <a href="#I:E">E</a> <a href="#I:F">F</a> <a href="#I:G">G</a> <a href="#I:H">H</a> <a href="#I:I">I</a> <a href="#I:L">L</a> <a href="#I:M">M</a> <a href="#I:N">N</a> <a href="#I:O">O</a> <a href="#I:P">P</a> <a href="#I:R">R</a> <a href="#I:S">S</a> <a href="#I:T">T</a> <a href="#I:V">V</a> <a name="I:A"> <!-- --> </a> <h2 class="title">A</h2> <dl> +<dt><span class="memberNameLink"><a href="bjc/everge/ReplSet.html#addPairs-java.util.List-">addPairs(List<ReplPair>)</a></span> - Method in class bjc.everge.<a href="bjc/everge/ReplSet.html" title="class in bjc.everge">ReplSet</a></dt> +<dd> +<div class="block">Adds more pairs to the ReplSet.</div> +</dd> +<dt><span class="memberNameLink"><a href="bjc/everge/ReplSet.html#addPairs-bjc.everge.ReplPair...-">addPairs(ReplPair...)</a></span> - Method in class bjc.everge.<a href="bjc/everge/ReplSet.html" title="class in bjc.everge">ReplSet</a></dt> +<dd> +<div class="block">Adds more pairs to the ReplSet.</div> +</dd> <dt><span class="memberNameLink"><a href="bjc/everge/ReplPair.html#apply-java.lang.String-">apply(String)</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/ReplSet.html#apply-java.lang.String-">apply(String)</a></span> - Method in class bjc.everge.<a href="bjc/everge/ReplSet.html" title="class in bjc.everge">ReplSet</a></dt> +<dd> +<div class="block">Apply the ReplSet to a string.</div> +</dd> +<dt><span class="memberNameLink"><a href="bjc/everge/ControlledString.Control.html#args">args</a></span> - Variable in class bjc.everge.<a href="bjc/everge/ControlledString.Control.html" title="class in bjc.everge">ControlledString.Control</a></dt> +<dd> +<div class="block">The arguments to the control.</div> +</dd> </dl> <a name="I:B"> <!-- --> @@ -92,6 +108,42 @@ <dl> <dt><span class="memberNameLink"><a href="bjc/everge/ReplPair.html#compareTo-bjc.everge.ReplPair-">compareTo(ReplPair)</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/ControlledString.Control.html#Control--">Control()</a></span> - Constructor for class bjc.everge.<a href="bjc/everge/ControlledString.Control.html" title="class in bjc.everge">ControlledString.Control</a></dt> +<dd> +<div class="block">Create a new blank control.</div> +</dd> +<dt><span class="memberNameLink"><a href="bjc/everge/ControlledString.Control.html#Control-java.lang.String-">Control(String)</a></span> - Constructor for class bjc.everge.<a href="bjc/everge/ControlledString.Control.html" title="class in bjc.everge">ControlledString.Control</a></dt> +<dd> +<div class="block">Create a new argless control.</div> +</dd> +<dt><span class="memberNameLink"><a href="bjc/everge/ControlledString.Control.html#Control-java.lang.String-java.lang.String...-">Control(String, String...)</a></span> - Constructor for class bjc.everge.<a href="bjc/everge/ControlledString.Control.html" title="class in bjc.everge">ControlledString.Control</a></dt> +<dd> +<div class="block">Create a new control.</div> +</dd> +<dt><a href="bjc/everge/ControlledString.html" title="class in bjc.everge"><span class="typeNameLink">ControlledString</span></a> - Class in <a href="bjc/everge/package-summary.html">bjc.everge</a></dt> +<dd> +<div class="block">Represents a string with a set of control flags attached to it.</div> +</dd> +<dt><span class="memberNameLink"><a href="bjc/everge/ControlledString.html#ControlledString--">ControlledString()</a></span> - Constructor for class bjc.everge.<a href="bjc/everge/ControlledString.html" title="class in bjc.everge">ControlledString</a></dt> +<dd> +<div class="block">Create a new blank controlled string.</div> +</dd> +<dt><span class="memberNameLink"><a href="bjc/everge/ControlledString.html#ControlledString-java.lang.String-">ControlledString(String)</a></span> - Constructor for class bjc.everge.<a href="bjc/everge/ControlledString.html" title="class in bjc.everge">ControlledString</a></dt> +<dd> +<div class="block">Create a new controlled string without any controls.</div> +</dd> +<dt><span class="memberNameLink"><a href="bjc/everge/ControlledString.html#ControlledString-java.lang.String-bjc.everge.ControlledString.Control...-">ControlledString(String, ControlledString.Control...)</a></span> - Constructor for class bjc.everge.<a href="bjc/everge/ControlledString.html" title="class in bjc.everge">ControlledString</a></dt> +<dd> +<div class="block">Create a new controlled string.</div> +</dd> +<dt><a href="bjc/everge/ControlledString.Control.html" title="class in bjc.everge"><span class="typeNameLink">ControlledString.Control</span></a> - Class in <a href="bjc/everge/package-summary.html">bjc.everge</a></dt> +<dd> +<div class="block">Represents a single control (a key-values pair)</div> +</dd> +<dt><span class="memberNameLink"><a href="bjc/everge/ControlledString.html#controls">controls</a></span> - Variable in class bjc.everge.<a href="bjc/everge/ControlledString.html" title="class in bjc.everge">ControlledString</a></dt> +<dd> +<div class="block">The controls that apply to the string.</div> +</dd> </dl> <a name="I:D"> <!-- --> @@ -154,6 +206,8 @@ <dd> <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> </dl> <a name="I:G"> <!-- --> @@ -165,6 +219,16 @@ <div class="block">Get the value.</div> </dd> </dl> +<a name="I:H"> +<!-- --> +</a> +<h2 class="title">H</h2> +<dl> +<dt><span class="memberNameLink"><a href="bjc/everge/ControlledString.html#hasControls--">hasControls()</a></span> - Method in class bjc.everge.<a href="bjc/everge/ControlledString.html" title="class in bjc.everge">ControlledString</a></dt> +<dd> +<div class="block">Check if the string has controls.</div> +</dd> +</dl> <a name="I:I"> <!-- --> </a> @@ -194,6 +258,8 @@ <dd> <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> <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> @@ -232,6 +298,10 @@ </a> <h2 class="title">N</h2> <dl> +<dt><span class="memberNameLink"><a href="bjc/everge/ControlledString.Control.html#name">name</a></span> - Variable in class bjc.everge.<a href="bjc/everge/ControlledString.Control.html" title="class in bjc.everge">ControlledString.Control</a></dt> +<dd> +<div class="block">The name of the control.</div> +</dd> <dt><span class="memberNameLink"><a href="bjc/everge/ReplPair.html#name">name</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 name of this replacement.</div> @@ -256,6 +326,10 @@ </a> <h2 class="title">P</h2> <dl> +<dt><span class="memberNameLink"><a href="bjc/everge/ControlledString.html#parse-java.lang.String-java.lang.String-java.lang.String-java.lang.String-java.lang.String-">parse(String, String, String, String, String)</a></span> - Static method in class bjc.everge.<a href="bjc/everge/ControlledString.html" title="class in bjc.everge">ControlledString</a></dt> +<dd> +<div class="block">Parse a controlled string from a regular string.</div> +</dd> <dt><span class="memberNameLink"><a href="bjc/everge/ReplPair.html#priority">priority</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 priority for this replacement.</div> @@ -301,7 +375,10 @@ an existing list.</div> </dd> <dt><span class="memberNameLink"><a href="bjc/everge/ReplPair.html#readList-java.util.List-java.util.Scanner-java.util.List-bjc.everge.ReplOpts-">readList(List<ReplPair>, Scanner, List<ReplError>, ReplOpts)</a></span> - Static method in class bjc.everge.<a href="bjc/everge/ReplPair.html" title="class in bjc.everge">ReplPair</a></dt> -<dd> </dd> +<dd> +<div class="block">Read a list of replacement pairs from an input source, adding them to + an existing list.</div> +</dd> <dt><span class="memberNameLink"><a href="bjc/everge/ReplPair.html#replace">replace</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 string to replace it with.</div> @@ -354,6 +431,18 @@ <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> +</dd> +<dt><span class="memberNameLink"><a href="bjc/everge/ReplSet.html#ReplSet--">ReplSet()</a></span> - Constructor for class bjc.everge.<a href="bjc/everge/ReplSet.html" title="class in bjc.everge">ReplSet</a></dt> +<dd> +<div class="block">Create a new blank set of pairs.</div> +</dd> +<dt><span class="memberNameLink"><a href="bjc/everge/ReplSet.html#ReplSet-java.util.List-">ReplSet(List<ReplPair>)</a></span> - Constructor for class bjc.everge.<a href="bjc/everge/ReplSet.html" title="class in bjc.everge">ReplSet</a></dt> +<dd> +<div class="block">Create a new set of pairs using an existing list of pairs.</div> +</dd> </dl> <a name="I:S"> <!-- --> @@ -366,6 +455,10 @@ <dd> <div class="block">Possible statuses of pairs with respect to exporting.</div> </dd> +<dt><span class="memberNameLink"><a href="bjc/everge/ControlledString.html#strang">strang</a></span> - Variable in class bjc.everge.<a href="bjc/everge/ControlledString.html" title="class in bjc.everge">ControlledString</a></dt> +<dd> +<div class="block">The string the controls apply to.</div> +</dd> <dt><a href="bjc/everge/StringUtils.html" title="class in bjc.everge"><span class="typeNameLink">StringUtils</span></a> - Class in <a href="bjc/everge/package-summary.html">bjc.everge</a></dt> <dd> <div class="block">Utility methods for strings.</div> @@ -423,7 +516,7 @@ the order they are declared.</div> the order they are declared.</div> </dd> </dl> -<a href="#I:A">A</a> <a href="#I:B">B</a> <a href="#I:C">C</a> <a href="#I:D">D</a> <a href="#I:E">E</a> <a href="#I:F">F</a> <a href="#I:G">G</a> <a href="#I:I">I</a> <a href="#I:L">L</a> <a href="#I:M">M</a> <a href="#I:N">N</a> <a href="#I:O">O</a> <a href="#I:P">P</a> <a href="#I:R">R</a> <a href="#I:S">S</a> <a href="#I:T">T</a> <a href="#I:V">V</a> </div> +<a href="#I:A">A</a> <a href="#I:B">B</a> <a href="#I:C">C</a> <a href="#I:D">D</a> <a href="#I:E">E</a> <a href="#I:F">F</a> <a href="#I:G">G</a> <a href="#I:H">H</a> <a href="#I:I">I</a> <a href="#I:L">L</a> <a href="#I:M">M</a> <a href="#I:N">N</a> <a href="#I:O">O</a> <a href="#I:P">P</a> <a href="#I:R">R</a> <a href="#I:S">S</a> <a href="#I:T">T</a> <a href="#I:V">V</a> </div> <!-- ======= START OF BOTTOM NAVBAR ====== --> <div class="bottomNav"><a name="navbar.bottom"> <!-- --> |