ReplError (everge 1.0-SNAPSHOT API)

java.lang.Object
-
- bjc.replpair.ReplError
-

-
-
-
```
public class ReplError
-extends Object
```
-
Represents an error encountered parsing ReplPairs
-
-
Author:
-
Ben Culkin
-
-

- -

Field Summary

- - - - - - - - - - - - - - - - - - - - - - -

Fields
Modifier and Type	Field and Description
`int`	`line` - The line the error occured on. -
`String`	`msg` - The message of the error. -
`int`	`numPairs` - The number of pairs we have processed so far. -
`String`	`txt` - The text of the line we errored on. -

- -

- - -
Constructor Summary
- - - - - - - - -
Constructors
Constructor and Description
ReplError(int lne, - int nPairs, - String msg, - String txt) -
Create a new ReplPair parse error.
-
-

Constructors
Constructor and Description
`ReplError(int lne, - int nPairs, - String msg, - String txt)` - Create a new ReplPair parse error. -

- -

- - -
Method Summary
- - - - - - - - - - -
All Methods Instance Methods Concrete Methods
Modifier and Type Method and Description
String toString()
-
- - - -
  Methods inherited from class java.lang.Object
  -clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
-

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`toString()`

- -
- - - -
  Field Detail
  - - - -
  - -
    line
    -
```
public int line
```
    -
    The line the error occured on.
    -
  - - - -
  - -
    numPairs
    -
```
public int numPairs
```
    -
    The number of pairs we have processed so far.
    -
  - - - -
  - -
    txt
    -
```
public String txt
```
    -
    The text of the line we errored on.
    -
  - - - -
  - -
    msg
    -
```
public String msg
```
    -
    The message of the error.
    -
  -
- -
- - - -
  Constructor Detail
  - - - -
  - -
    ReplError
    -
```
public ReplError(int lne,
-                 int nPairs,
-                 String msg,
-                 String txt)
```
    -
    Create a new ReplPair parse error.
    -
    -
    Parameters:
    -
    lne - The line the error occured on.
    -
    nPairs - The number of pairs processed up to this point.
    -
    msg - The message detailing the error.
    -
    txt - The text that caused the error.
    -
    -
  -
- -
- - - -
  Method Detail
  - - - -
  - -
    toString
    -
```
public String toString()
```
    -
    -
    Overrides:
    -
    toString in class Object
    -
    -
  -
-

java.lang.Object
-
- bjc.replpair.ReplPair
-

-
-
All Implemented Interfaces:
-
Comparable<ReplPair>, Function<String,String>, UnaryOperator<String>
-
-
-
-
```
public class ReplPair
-extends Object
-implements Comparable<ReplPair>, UnaryOperator<String>
```
-
String pairs for replacements.
-
-
Author:
-
Ben Culkin
-
-

- -

- - -

Field Summary

- - - - - - - - - - - - - - - - - - - - - - -

Fields
Modifier and Type	Field and Description
`String`	`find` - The string to look for. -
`String`	`name` - The name of this replacement. -
`int`	`priority` - The priority for this replacement. -
`String`	`replace` - The string to replace it with. -

- -

- - -

Constructor Summary

- - - - - - - - - - - - - - - - - - - - -

Constructors
Constructor and Description
`ReplPair()` - Create a new blank replacement pair. -
`ReplPair(String f, - String r)` - Create a new replacement pair with a priority of 1. -
`ReplPair(String f, - String r, - int p)` - Create a new replacement pair with a set priority. -
`ReplPair(String f, - String r, - int p, - String n)` - Create a new replacement pair with a set priority and name. -
`ReplPair(String f, - String r, - String n)` - Create a new named replacement pair with a priority of 1. -

- -

- - -

Method Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`apply(String inp)`
`int`	`compareTo(ReplPair rp)`
`static List<ReplPair>`	`readList(List<ReplPair> detals, - Scanner scn)` - Read a list of replacement pairs from an input source, adding them to - an existing list. -
`static List<ReplPair>`	`readList(List<ReplPair> detals, - Scanner scn, - List<ReplError> errs)` - Read a list of replacement pairs from an input source, adding them to - an existing list. -
`static List<ReplPair>`	`readList(Scanner scn)` - Read a list of replacement pairs from an input source. -
`String`	`toString()`

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

- - -
Methods inherited from interface java.util.function.UnaryOperator
-identity

- - -
Methods inherited from interface java.util.function.Function
-andThen, compose

- -
- - - -
  Field Detail
  - - - -
  - -
    priority
    -
```
public int priority
```
    -
    The priority for this replacement.
    -
  - - - -
  - -
    name
    -
```
public String name
```
    -
    The name of this replacement. - - Defaults to the 'find' string.
    -
  - - - -
  - -
    find
    -
```
public String find
```
    -
    The string to look for.
    -
  - - - -
  - -
    replace
    -
```
public String replace
```
    -
    The string to replace it with.
    -
  -
- -
- - - -
  Constructor Detail
  - - - -
  - -
    ReplPair
    -
```
public ReplPair()
```
    -
    Create a new blank replacement pair.
    -
  - - - -
  - -
    ReplPair
    -
```
public ReplPair(String f,
-                String r)
```
    -
    Create a new replacement pair with a priority of 1.
    -
    -
    Parameters:
    -
    f - The string to find.
    -
    r - The string to replace.
    -
    -
  - - - -
  - -
    ReplPair
    -
```
public ReplPair(String f,
-                String r,
-                String n)
```
    -
    Create a new named replacement pair with a priority of 1.
    -
    -
    Parameters:
    -
    f - The string to find.
    -
    r - The string to replace.
    -
    n - The name of the replacement pair.
    -
    -
  - - - -
  - -
    ReplPair
    -
```
public ReplPair(String f,
-                String r,
-                int p)
```
    -
    Create a new replacement pair with a set priority.
    -
    -
    Parameters:
    -
    f - The string to find.
    -
    r - The string to replace.
    -
    p - The priority for the replacement.
    -
    -
  - - - -
  - -
    ReplPair
    -
```
public ReplPair(String f,
-                String r,
-                int p,
-                String n)
```
    -
    Create a new replacement pair with a set priority and name.
    -
    -
    Parameters:
    -
    f - The string to find.
    -
    r - The string to replace.
    -
    n - The name of the replacement pair.
    -
    p - The priority for the replacement.
    -
    -
  -
- -
- - - -
  Method Detail
  - - - -
  - -
    readList
    -
```
public static List<ReplPair> readList(Scanner scn)
```
    -
    Read a list of replacement pairs from an input source.
    -
    -
    Parameters:
    -
    scn - The source to read the replacements from.
    -
    Returns:
    -
    The list of replacements.
    -
    -
  - - - -
  - -
    readList
    -
```
public static List<ReplPair> readList(List<ReplPair> detals,
-                                      Scanner scn)
```
    -
    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.
    -
    Returns:
    -
    The list of replacements.
    -
    -
  - - - -
  - -
    readList
    -
```
public static List<ReplPair> readList(List<ReplPair> detals,
-                                      Scanner scn,
-                                      List<ReplError> errs)
```
    -
    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.
    -
    Returns:
    -
    The list of replacements.
    -
    -
  - - - -
  - -
    apply
    -
```
public String apply(String inp)
```
    -
    -
    Specified by:
    -
    apply in interface Function<String,String>
    -
    -
  - - - -
  - -
    toString
    -
```
public String toString()
```
    -
    -
    Overrides:
    -
    toString in class Object
    -
    -
  - - - -
  - -
    compareTo
    -
```
public int compareTo(ReplPair rp)
```
    -
    -
    Specified by:
    -
    compareTo in interface Comparable<ReplPair>
    -
    -
  -
-

java.lang.Object
-
- java.lang.Enum<StageStatus>
- -
  - bjc.replpair.StageStatus
  -
-

-
-
All Implemented Interfaces:
-
Serializable, Comparable<StageStatus>
-
-
-
-
```
public enum StageStatus
-extends Enum<StageStatus>
```
-
Possible statuses of pairs with respect to exporting.
-
-
Author:
-
Ben Culkin
-
-

- -

- - -
Enum Constant Summary
- - - - - - - - - - - - - - -
Enum Constants
Enum Constant and Description
BOTH -
Use for staging pairs; do export.
-
EXTERNAL -
Don't use for staging pairs; do export.
-
INTERNAL -
Only use for staging pairs; don't export.
-
-

Enum Constants
Enum Constant and Description
`BOTH` - Use for staging pairs; do export. -
`EXTERNAL` - Don't use for staging pairs; do export. -
`INTERNAL` - Only use for staging pairs; don't export. -

- -

- - -

Method Summary

- - - - - - - - - - - - - - -

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static StageStatus`	`valueOf(String name)` - Returns the enum constant of this type with the specified name. -
`static StageStatus[]`	`values()` - Returns an array containing the constants of this enum type, in -the order they are declared. -

- - -
Methods inherited from class java.lang.Enum
-clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

- - -
Methods inherited from class java.lang.Object
-getClass, notify, notifyAll, wait, wait, wait

- -
- - - -
  Enum Constant Detail
  - - - -
  - -
    INTERNAL
    -
```
public static final StageStatus INTERNAL
```
    -
    Only use for staging pairs; don't export.
    -
  - - - -
  - -
    EXTERNAL
    -
```
public static final StageStatus EXTERNAL
```
    -
    Don't use for staging pairs; do export.
    -
  - - - -
  - -
    BOTH
    -
```
public static final StageStatus BOTH
```
    -
    Use for staging pairs; do export.
    -
  -
- -
- - - -
  Method Detail
  - - - -
  - -
    values
    -
```
public static StageStatus[] values()
```
    -
    Returns an array containing the constants of this enum type, in -the order they are declared. This method may be used to iterate -over the constants as follows: -
```
-for (StageStatus c : StageStatus.values())
-    System.out.println(c);
-
```
    -
    -
    Returns:
    -
    an array containing the constants of this enum type, in the order they are declared
    -
    -
  - - - -
  - -
    valueOf
    -
```
public static StageStatus valueOf(String name)
```
    -
    Returns the enum constant of this type with the specified name. -The string must match exactly an identifier used to declare an -enum constant in this type. (Extraneous whitespace characters are -not permitted.)
    -
    -
    Parameters:
    -
    name - the name of the enum constant to be returned.
    -
    Returns:
    -
    the enum constant with the specified name
    -
    Throws:
    -
    IllegalArgumentException - if this enum type has no constant with the specified name
    -
    NullPointerException - if the argument is null
    -
    -
  -
-

Method parameters in bjc.replpair with type arguments of type ReplError
Modifier and Type	Method and Description
`static List<ReplPair>`	ReplPair.`readList(List<ReplPair> detals, - Scanner scn, - List<ReplError> errs)` - Read a list of replacement pairs from an input source, adding them to - an existing list. -

- - -

Uses of ReplPair in bjc.replpair

- - - - - - - - - - - - - - - - - - - - -

Methods in bjc.replpair that return types with arguments of type ReplPair
Modifier and Type	Method and Description
`static List<ReplPair>`	ReplPair.`readList(List<ReplPair> detals, - Scanner scn)` - Read a list of replacement pairs from an input source, adding them to - an existing list. -
`static List<ReplPair>`	ReplPair.`readList(List<ReplPair> detals, - Scanner scn, - List<ReplError> errs)` - Read a list of replacement pairs from an input source, adding them to - an existing list. -
`static List<ReplPair>`	ReplPair.`readList(Scanner scn)` - Read a list of replacement pairs from an input source. -

- - - - - - - - - - - - -

Methods in bjc.replpair with parameters of type ReplPair
Modifier and Type	Method and Description
`int`	ReplPair.`compareTo(ReplPair rp)`

- - - - - - - - - - - - - - - - -

Method parameters in bjc.replpair with type arguments of type ReplPair
Modifier and Type	Method and Description
`static List<ReplPair>`	ReplPair.`readList(List<ReplPair> detals, - Scanner scn)` - Read a list of replacement pairs from an input source, adding them to - an existing list. -
`static List<ReplPair>`	ReplPair.`readList(List<ReplPair> detals, - Scanner scn, - List<ReplError> errs)` - Read a list of replacement pairs from an input source, adding them to - an existing list. -

Modifier and Type	Method and Description
`static StageStatus`	StageStatus.`valueOf(String name)` - Returns the enum constant of this type with the specified name. -
`static StageStatus[]`	StageStatus.`values()` - Returns an array containing the constants of this enum type, in -the order they are declared. -

Class	Description
ReplError	- Represents an error encountered parsing ReplPairs -
ReplPair	- String pairs for replacements. -

Class ReplError

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

line

numPairs

txt

msg

Constructor Detail

ReplError

Method Detail

toString

Class ReplPair

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.function.UnaryOperator

Methods inherited from interface java.util.function.Function

Field Detail

priority

name

find

replace

Constructor Detail

ReplPair

ReplPair

ReplPair

ReplPair

ReplPair

Method Detail

readList

readList

readList

apply

toString

compareTo

Enum StageStatus

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

INTERNAL

EXTERNAL

BOTH

Method Detail

values

valueOf

Uses of Classbjc.replpair.ReplError

Uses of ReplError in bjc.replpair

Uses of Classbjc.replpair.ReplPair

Uses of ReplPair in bjc.replpair

Uses of Classbjc.replpair.StageStatus

Uses of StageStatus in bjc.replpair

bjc.replpair

Classes

Enums

Package bjc.replpair

Hierarchy For Package bjc.replpair

Class Hierarchy

Enum Hierarchy

Uses of Packagebjc.replpair

Uses of Class
bjc.replpair.ReplError

Uses of Class
bjc.replpair.ReplPair

Uses of Class
bjc.replpair.StageStatus

Uses of Package
bjc.replpair