ControlledString.Control (everge 1.0-SNAPSHOT API)

Fields
Modifier and Type	Field and Description
`static boolean`	`isDebug`

Fields in bjc.everge declared as ControlledString.Control
Modifier and Type	Field and Description
`ControlledString.Control[]`	ControlledString.`controls` + The controls that apply to the string. +

Constructors in bjc.everge with parameters of type ControlledString.Control
Constructor and Description
`ControlledString(String strung, + ControlledString.Control... controls)` + Create a new controlled string. +

Methods in bjc.everge that return ControlledString
Modifier and Type	Method and Description
`static ControlledString`	ControlledString.`parse(String lne, + String contInd, + String contSep, + String contArg, + String contEsc)` + Parse a controlled string from a regular string. +

java.lang.Object
+
- bjc.everge.ControlledString.Control
+

+
+
Enclosing class:
+
ControlledString
+
+
+
+
```
public static class ControlledString.Control
+extends Object
```
+
Represents a single control (a key-values pair)
+
+
Author:
+
Ben Culkin
+
+

+ +

+ + +
Field Summary
+ + + + + + + + + + + + + + +
Fields
Modifier and Type Field and Description
String[] args +
The arguments to the control.
+
String name +
The name of the control.
+
+

Fields
Modifier and Type	Field and Description
`String[]`	`args` + The arguments to the control. +
`String`	`name` + The name of the control. +

+ +

Constructor Summary

+ + + + + + + + + + + + + + +

Constructors
Constructor and Description
`Control()` + Create a new blank control. +
`Control(String nam)` + Create a new argless control. +
`Control(String nam, + String... ars)` + Create a new control. +

+ +

+ + +
Method Summary
+
- + + +
  Methods inherited from class java.lang.Object
  +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+

+ +
- + + +
  Field Detail
  + + + +
  - +
    name
    +
```
public String name
```
    +
    The name of the control.
    +
  + + + +
  - +
    args
    +
```
public String[] args
```
    +
    The arguments to the control.
    +
  +
+ +
- + + +
  Constructor Detail
  + + + +
  - +
    Control
    +
```
public Control()
```
    +
    Create a new blank control.
    +
  + + + +
  - +
    Control
    +
```
public Control(String nam)
```
    +
    Create a new argless control.
    +
    +
    Parameters:
    +
    nam - The name of the control.
    +
    +
  + + + +
  - +
    Control
    +
```
public Control(String nam,
+               String... ars)
```
    +
    Create a new control.
    +
    +
    Parameters:
    +
    nam - The name of the control.
    +
    ars - The arguments of the control.
    +
    +
  +
+

Prev Class
Next Class

Frames
No Frames

All Classes

+ +

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

+ + +

Prev Class
Next Class

Frames
No Frames

All Classes

+ +

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

+ + +

java.lang.Object
+
- bjc.everge.ControlledString
+

+
+
+
```
public class ControlledString
+extends Object
```
+
Represents a string with a set of control flags attached to it.
+
+
Author:
+
Ben Culkin
+
+

+ +

+ + +
Nested Class Summary
+ + + + + + + + + + +
Nested Classes
Modifier and Type Class and Description
static class ControlledString.Control +
Represents a single control (a key-values pair)
+
+

Nested Classes
Modifier and Type	Class and Description
`static class`	`ControlledString.Control` + Represents a single control (a key-values pair) +

+ +

+ + +
Field Summary
+ + + + + + + + + + + + + + +
Fields
Modifier and Type Field and Description
ControlledString.Control[] controls +
The controls that apply to the string.
+
String strang +
The string the controls apply to.
+
+

Fields
Modifier and Type	Field and Description
`ControlledString.Control[]`	`controls` + The controls that apply to the string. +
`String`	`strang` + The string the controls apply to. +

+ +

+ + +

Constructor Summary

+ + + + + + + + + + + + + + +

Constructors
Constructor and Description
`ControlledString()` + Create a new blank controlled string. +
`ControlledString(String strung)` + Create a new controlled string without any controls. +
`ControlledString(String strung, + ControlledString.Control... controls)` + Create a new controlled string. +

+ +

+ + +

Method Summary

+ + + + + + + + + + + + + + +

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`hasControls()` + Check if the string has controls. +
`static ControlledString`	`parse(String lne, + String contInd, + String contSep, + String contArg, + String contEsc)` + Parse a controlled string from a regular string. +

+ + +
Methods inherited from class java.lang.Object
+clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

+ +
- + + +
  Field Detail
  + + + +
  - +
    strang
    +
```
public String strang
```
    +
    The string the controls apply to.
    +
  + + + +
  - +
    controls
    +
```
public ControlledString.Control[] controls
```
    +
    The controls that apply to the string.
    +
  +
+ +
- + + +
  Constructor Detail
  + + + +
  - +
    ControlledString
    +
```
public ControlledString()
```
    +
    Create a new blank controlled string.
    +
  + + + +
  - +
    ControlledString
    +
```
public ControlledString(String strung)
```
    +
    Create a new controlled string without any controls.
    +
    +
    Parameters:
    +
    strung - The string to use.
    +
    +
  + + + +
  - +
    ControlledString
    +
```
public ControlledString(String strung,
+                        ControlledString.Control... controls)
```
    +
    Create a new controlled string.
    +
    +
    Parameters:
    +
    strung - The string to use.
    +
    controls - The controls that apply to the string.
    +
    +
  +
+ +
- + + +
  Method Detail
  + + + +
  - +
    hasControls
    +
```
public boolean hasControls()
```
    +
    Check if the string has controls.
    +
    +
    Returns:
    +
    Whether or not the string has controls.
    +
    +
  + + + +
  - +
    parse
    +
```
public static ControlledString parse(String lne,
+                                     String contInd,
+                                     String contSep,
+                                     String contArg,
+                                     String contEsc)
```
    +
    Parse a controlled string from a regular string. + + The controls must be parsed from the beginning of the string, and are indicated by occurances + of contInd that bracket them from the string. The individual controls are delimited by + instances of contSep, with arguments to them being separated by occurances of contArg. + + Each of those separators (which must be regular strings, not regexes or anything) may be + escaped by preceeding them with a copy of contEsc.
    +
    +
    Parameters:
    +
    lne - The string to parse frmo.
    +
    contInd - The indicator for whether or not there are controls.
    +
    contSep - The separator of individual controls.
    +
    contArg - The separator of control arguments.
    +
    contEsc - The escape string for each of the separators/indicators.
    +
    Returns:
    +
    A parsed control string.
    +
    +
  +
+

Prev Class
Next Class

Frames
No Frames

All Classes

+ +

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

+ + +

Prev Class
Prev Class
Next Class

Prev Class

Prev Class
Next Class

IntHolder (everge 1.0-SNAPSHOT API)

ReplError (everge 1.0-SNAPSHOT API)

ReplOpts (everge 1.0-SNAPSHOT API)

ReplPair (everge 1.0-SNAPSHOT API)

readList(List<ReplPair> detals,
         Scanner scn,
         List<ReplError> errs,
-        ReplOpts ropts)

ReplOpts

Read a list of replacement pairs from an input source, adding them to + an existing list.

static List<ReplPair>

Read a list of replacement pairs from an input source, adding them to + an existing list.

Parameters:: detals - The list to add the replacements to.; scn - The source to read the replacements from.; errs - The list to stick errors in.; ropts - The options to use when reading the pairs.
Returns:: The list of replacements.

diff --git a/docs/apidocs/bjc/everge/ReplParseException.html b/docs/apidocs/bjc/everge/ReplParseException.html index 2ffec2e..ebb00ba 100644 --- a/docs/apidocs/bjc/everge/ReplParseException.html +++ b/docs/apidocs/bjc/everge/ReplParseException.html @@ -2,10 +2,10 @@ - + ReplParseException (everge 1.0-SNAPSHOT API) - + @@ -50,7 +50,7 @@ var activeTableTab = "activeTableTab";

Frames

Frames

ReplSet (everge 1.0-SNAPSHOT API)

+ + +

Skip navigation links

+ + + +

Prev Class
Next Class

Frames
No Frames

All Classes

+ +

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

+ + +

java.lang.Object
+
- bjc.everge.ReplSet
+

+
+
+
```
public class ReplSet
+extends Object
```
+
A set of ReplPairs, kept together for easy use
+
+
Author:
+
Ben Culkin
+
+

+ +

+ + +
Constructor Summary
+ + + + + + + + + + + +
Constructors
Constructor and Description
ReplSet() +
Create a new blank set of pairs.
+
ReplSet(List<ReplPair> lst) +
Create a new set of pairs using an existing list of pairs.
+
+

Constructors
Constructor and Description
`ReplSet()` + Create a new blank set of pairs. +
`ReplSet(List<ReplPair> lst)` + Create a new set of pairs using an existing list of pairs. +

+ +

+ + +

Method Summary

+ + + + + + + + + + + + + + + + + + + + + + +

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addPairs(List<ReplPair> pars)` + Adds more pairs to the ReplSet. +
`void`	`addPairs(ReplPair... pars)` + Adds more pairs to the ReplSet. +
`String`	`apply(String val)` + Apply the ReplSet to a string. +
`static ReplSet`	`fromFile(String fName)`

+ + +
Methods inherited from class java.lang.Object
+clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

+ +
- + + +
  Constructor Detail
  + + + +
  - +
    ReplSet
    +
```
public ReplSet()
```
    +
    Create a new blank set of pairs.
    +
  + + + +
  - +
    ReplSet
    +
```
public ReplSet(List<ReplPair> lst)
```
    +
    Create a new set of pairs using an existing list of pairs. + + Changes to the list of pairs will carry across to the ReplSet, so be careful about that.
    +
    +
    Parameters:
    +
    lst - The list of pairs to use.
    +
    +
  +
+ +
- + + +
  Method Detail
  + + + +
  - +
    fromFile
    +
```
public static ReplSet fromFile(String fName)
+                        throws IOException
```
    +
    +
    Throws:
    +
    IOException
    +
    +
  + + + +
  - +
    addPairs
    +
```
public void addPairs(List<ReplPair> pars)
```
    +
    Adds more pairs to the ReplSet.
    +
    +
    Parameters:
    +
    pars - The pairs to add to the ReplSet.
    +
    +
  + + + +
  - +
    addPairs
    +
```
public void addPairs(ReplPair... pars)
```
    +
    Adds more pairs to the ReplSet.
    +
    +
    Parameters:
    +
    pars - The pairs to add to the ReplSet.
    +
    +
  + + + +
  - +
    apply
    +
```
public String apply(String val)
```
    +
    Apply the ReplSet to a string.
    +
    +
    Parameters:
    +
    val - The string to apply the ReplSet to.
    +
    Returns:
    +
    The result of applying the ReplSet.
    +
    +
  +
+

+ + +

Skip navigation links

+ + + +

Prev Class
Next Class

Frames
No Frames

All Classes

+ +

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

+ + +

StageStatus (everge 1.0-SNAPSHOT API)

@@ -321,7 +321,7 @@ not permitted.)

StringUtils (everge 1.0-SNAPSHOT API)

Detail:
Field |
Field |
Constr |
Method

+ +
+
+ + +
Field Summary
+ + + + + + + + + + +
Fields
Modifier and Type Field and Description
static boolean isDebug
+
+

@@ -175,6 +194,23 @@ extends

+ +
+
+ + +
Field Detail
+ + + +
+
+
isDebug
+
public static boolean isDebug
+
+
+
+

@@ -271,13 +307,13 @@ extends
Summary:

Nested |
-
Field |
+
Field |

Constr |

Method

Detail:
-
Field |
+
Field |

Constr |

Method

diff --git a/docs/apidocs/bjc/everge/class-use/ControlledString.Control.html b/docs/apidocs/bjc/everge/class-use/ControlledString.Control.html new file mode 100644 index 0000000..943903d --- /dev/null +++ b/docs/apidocs/bjc/everge/class-use/ControlledString.Control.html @@ -0,0 +1,165 @@ + + + + + + +Uses of Class bjc.everge.ControlledString.Control (everge 1.0-SNAPSHOT API) + + + + + + + + +
+ + +
Skip navigation links
+ + + +
+
Package
+
Class
+
Use
+
Tree
+
Deprecated
+
Index
+
Help
+
+
+
+
+
Prev
+
Next
+
+
+
Frames
+
No Frames
+
+
+
All Classes
+
+
+ +
+ + +
+ +
+
Uses of Class
bjc.everge.ControlledString.Control
+
+
+
+
+
+
+ + +
Uses of ControlledString.Control in bjc.everge
+ + + + + + + + + + + + +
Fields in bjc.everge declared as ControlledString.Control
Modifier and Type Field and Description
ControlledString.Control[] ControlledString.controls +
The controls that apply to the string.
+
+ + + + + + + + + + +
Constructors in bjc.everge with parameters of type ControlledString.Control
Constructor and Description
ControlledString(String strung, + ControlledString.Control... controls) +
Create a new controlled string.
+
+
+
+
+
+
+ +
+ + +
Skip navigation links
+ + + +
+
Package
+
Class
+
Use
+
Tree
+
Deprecated
+
Index
+
Help
+
+
+
+
+
Prev
+
Next
+
+
+
Frames
+
No Frames
+
+
+
All Classes
+
+
+ +
+ + +
+ +
Copyright © 2019. All rights reserved.
+ + diff --git a/docs/apidocs/bjc/everge/class-use/ControlledString.html b/docs/apidocs/bjc/everge/class-use/ControlledString.html new file mode 100644 index 0000000..662286f --- /dev/null +++ b/docs/apidocs/bjc/everge/class-use/ControlledString.html @@ -0,0 +1,155 @@ + + + + + + +Uses of Class bjc.everge.ControlledString (everge 1.0-SNAPSHOT API) + + + + + + + + +
+ + +
Skip navigation links
+ + + +
+
Package
+
Class
+
Use
+
Tree
+
Deprecated
+
Index
+
Help
+
+
+
+
+
Prev
+
Next
+
+
+
Frames
+
No Frames
+
+
+
All Classes
+
+
+ +
+ + +
+ +
+
Uses of Class
bjc.everge.ControlledString
+
+
+
+
+
+
+ + +
Uses of ControlledString in bjc.everge
+ + + + + + + + + + + + +
Methods in bjc.everge that return ControlledString
Modifier and Type Method and Description
static ControlledString ControlledString.parse(String lne, + String contInd, + String contSep, + String contArg, + String contEsc) +
Parse a controlled string from a regular string.
+
+
+
+
+
+
+ +
+ + +
Skip navigation links
+ + + +
+
Package
+
Class
+
Use
+
Tree
+
Deprecated
+
Index
+
Help
+
+
+
+
+
Prev
+
Next
+
+
+
Frames
+
No Frames
+
+
+
All Classes
+
+
+ +
+ + +
+ +
Copyright © 2019. All rights reserved.
+ + diff --git a/docs/apidocs/bjc/everge/class-use/Everge.InputStatus.html b/docs/apidocs/bjc/everge/class-use/Everge.InputStatus.html index 81a7a08..470f6ed 100644 --- a/docs/apidocs/bjc/everge/class-use/Everge.InputStatus.html +++ b/docs/apidocs/bjc/everge/class-use/Everge.InputStatus.html @@ -2,10 +2,10 @@ - + Uses of Class bjc.everge.Everge.InputStatus (everge 1.0-SNAPSHOT API) - + diff --git a/docs/apidocs/bjc/everge/class-use/Everge.html b/docs/apidocs/bjc/everge/class-use/Everge.html index 2c6eee2..ef64800 100644 --- a/docs/apidocs/bjc/everge/class-use/Everge.html +++ b/docs/apidocs/bjc/everge/class-use/Everge.html @@ -2,10 +2,10 @@ - + Uses of Class bjc.everge.Everge (everge 1.0-SNAPSHOT API) - + diff --git a/docs/apidocs/bjc/everge/class-use/IntHolder.html b/docs/apidocs/bjc/everge/class-use/IntHolder.html index 07ae0b6..6e1d4a6 100644 --- a/docs/apidocs/bjc/everge/class-use/IntHolder.html +++ b/docs/apidocs/bjc/everge/class-use/IntHolder.html @@ -2,10 +2,10 @@ - + Uses of Class bjc.everge.IntHolder (everge 1.0-SNAPSHOT API) - + diff --git a/docs/apidocs/bjc/everge/class-use/ReplError.html b/docs/apidocs/bjc/everge/class-use/ReplError.html index 2115627..6e1bc28 100644 --- a/docs/apidocs/bjc/everge/class-use/ReplError.html +++ b/docs/apidocs/bjc/everge/class-use/ReplError.html @@ -2,10 +2,10 @@ - + Uses of Class bjc.everge.ReplError (everge 1.0-SNAPSHOT API) - + @@ -114,7 +114,10 @@ ReplPair.readList(List<ReplPair> detals, Scanner scn, List<ReplError> errs, - ReplOpts ropts) + ReplOpts ropts) +
Read a list of replacement pairs from an input source, adding them to + an existing list.
+ diff --git a/docs/apidocs/bjc/everge/class-use/ReplOpts.html b/docs/apidocs/bjc/everge/class-use/ReplOpts.html index 3d84a39..e0b4542 100644 --- a/docs/apidocs/bjc/everge/class-use/ReplOpts.html +++ b/docs/apidocs/bjc/everge/class-use/ReplOpts.html @@ -2,10 +2,10 @@ - + Uses of Class bjc.everge.ReplOpts (everge 1.0-SNAPSHOT API) - + @@ -92,7 +92,10 @@ ReplPair.readList(List<ReplPair> detals, Scanner scn, List<ReplError> errs, - ReplOpts ropts) + ReplOpts ropts) +
Read a list of replacement pairs from an input source, adding them to + an existing list.
+ diff --git a/docs/apidocs/bjc/everge/class-use/ReplPair.html b/docs/apidocs/bjc/everge/class-use/ReplPair.html index 2907d4c..f02c14b 100644 --- a/docs/apidocs/bjc/everge/class-use/ReplPair.html +++ b/docs/apidocs/bjc/everge/class-use/ReplPair.html @@ -2,10 +2,10 @@ - + Uses of Class bjc.everge.ReplPair (everge 1.0-SNAPSHOT API) - + @@ -109,7 +109,10 @@ ReplPair.readList(List<ReplPair> detals, Scanner scn, List<ReplError> errs, - ReplOpts ropts) + ReplOpts ropts) +
Read a list of replacement pairs from an input source, adding them to + an existing list.
+ static List<ReplPair> @@ -127,6 +130,12 @@ +void +ReplSet.addPairs(ReplPair... pars) +
Adds more pairs to the ReplSet.
+ + + int ReplPair.compareTo(ReplPair rp) @@ -140,6 +149,12 @@ +void +ReplSet.addPairs(List<ReplPair> pars) +
Adds more pairs to the ReplSet.
+ + + static List<ReplPair> ReplPair.readList(List<ReplPair> detals, Scanner scn) @@ -147,7 +162,7 @@ an existing list.

Constructor parameters in bjc.everge with type arguments of type ReplPair
Constructor and Description
`ReplSet(List<ReplPair> lst)` + Create a new set of pairs using an existing list of pairs. +

Frames
No Frames

All Classes

+ +

+ + +

Methods in bjc.everge that return ReplSet
Modifier and Type	Method and Description
`static ReplSet`	ReplSet.`fromFile(String fName)`

Frames
No Frames

All Classes

+ +

+ + +

Classes

Enums

diff --git a/docs/apidocs/bjc/everge/package-summary.html b/docs/apidocs/bjc/everge/package-summary.html index 7fa0e64..86bc127 100644 --- a/docs/apidocs/bjc/everge/package-summary.html +++ b/docs/apidocs/bjc/everge/package-summary.html @@ -2,10 +2,10 @@ - + bjc.everge (everge 1.0-SNAPSHOT API) - + @@ -83,6 +83,18 @@ +ControlledString + +

Represents a string with a set of control flags attached to it.

+ + + +ControlledString.Control + +

Represents a single control (a key-values pair)

+ + + Everge

Everge front-end application.

@@ -113,6 +125,12 @@ +ReplSet + +

A set of ReplPairs, kept together for easy use

+ + + StringUtils

Utility methods for strings.

diff --git a/docs/apidocs/bjc/everge/package-tree.html b/docs/apidocs/bjc/everge/package-tree.html index 4e3a096..9312b6d 100644 --- a/docs/apidocs/bjc/everge/package-tree.html +++ b/docs/apidocs/bjc/everge/package-tree.html @@ -2,10 +2,10 @@ - + bjc.everge Class Hierarchy (everge 1.0-SNAPSHOT API) - + @@ -77,11 +77,14 @@

java.lang.Object
- bjc.everge.ControlledString
- bjc.everge.ControlledString.Control
- bjc.everge.Everge
- bjc.everge.IntHolder
- bjc.everge.ReplError
- bjc.everge.ReplOpts
- bjc.everge.ReplPair (implements java.lang.Comparable<T>, java.util.function.UnaryOperator<T>)
- bjc.everge.ReplSet
- bjc.everge.StringUtils
- java.lang.Throwable (implements java.io.Serializable)

Class ControlledString.Control

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

name

args

Constructor Detail

Control

Control

Control

Class ControlledString

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

strang

controls

Constructor Detail

ControlledString

ControlledString

ControlledString

Method Detail

hasControls

parse

Class ReplSet

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ReplSet

ReplSet

Method Detail

fromFile

addPairs

addPairs

apply

Field Summary

Field Detail

isDebug

Uses of Classbjc.everge.ControlledString.Control

Uses of ControlledString.Control in bjc.everge

Uses of Classbjc.everge.ControlledString

Uses of ControlledString in bjc.everge

Uses of Classbjc.everge.ReplSet

Uses of ReplSet in bjc.everge

Classes

Enums

Uses of Class
bjc.everge.ControlledString.Control

Uses of Class
bjc.everge.ControlledString

Uses of Class
bjc.everge.ReplSet