bjc.everge

Class ReplPair

java.lang.Object

bjc.everge.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	guard The guard for this replacement.
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

Modifier and Type	Method and Description
String	apply(String inp)
int	compareTo(ReplPair rp)
boolean	equals(Object obj)
int	hashCode()
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(List<ReplPair> detals, Scanner scn, List<ReplError> errs, ReplOpts ropts) 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, finalize, getClass, 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.

guard

public String guard

The guard for this replacement. The guard of the replacement is a regex that has to match before the pair will be considered. Defaults to being blank.

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.

readList

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

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.

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>

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object