com.exsoinn.util

Enum EscapeUtil.EscapeToken

java.lang.Object

java.lang.Enum<EscapeUtil.EscapeToken>

com.exsoinn.util.EscapeUtil.EscapeToken

All Implemented Interfaces:

Serializable, Comparable<EscapeUtil.EscapeToken>

Enclosing class:

EscapeUtil

public static enum EscapeUtil.EscapeToken
extends Enum<EscapeUtil.EscapeToken>

Stores characters and what they're replacement should be within the Rule API. Escaping characters is sometimes required in order to be able to build a Context object, which the Rule API heavily depends on.

Enum Constant Summary

Enum Constants

Enum Constant and Description
AMPERSAND
ASTERISK
AT_MRK
BACK_SLASH
CAP_MRK
CLS_BRCK
COLON
COMMA
CURLY_BRCK_CLOSE
CURLY_BRCK_OPEN
DASH
DOUBLE_PIPE
EQUAL_SIGN
FORWARD_SLASH
HASH_MRK
OPEN_BRCK
PLUS
PRCNTG_MRK
QUESTION_MARK
SEMI_COLON
SINGLE_PIPE
SPACE
SQR_BRCK_CLOSE
SQR_BRCK_OPEN
TILT_MRK

Method Summary

Modifier and Type	Method and Description
String	replacement()
static String	replacementFromString(String pStr) Given a passed in string, returns what the replacement should be for escaping purposes.
String	restoreValue()
String	targetString()
static EscapeUtil.EscapeToken	valueOf(String name) Returns the enum constant of this type with the specified name.
static EscapeUtil.EscapeToken[]	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

SPACE

public static final EscapeUtil.EscapeToken SPACE

EQUAL_SIGN

public static final EscapeUtil.EscapeToken EQUAL_SIGN

SEMI_COLON

public static final EscapeUtil.EscapeToken SEMI_COLON

DOUBLE_PIPE

public static final EscapeUtil.EscapeToken DOUBLE_PIPE

COLON

public static final EscapeUtil.EscapeToken COLON

DASH

public static final EscapeUtil.EscapeToken DASH

SQR_BRCK_OPEN

public static final EscapeUtil.EscapeToken SQR_BRCK_OPEN

SQR_BRCK_CLOSE

public static final EscapeUtil.EscapeToken SQR_BRCK_CLOSE

BACK_SLASH

public static final EscapeUtil.EscapeToken BACK_SLASH

FORWARD_SLASH

public static final EscapeUtil.EscapeToken FORWARD_SLASH

QUESTION_MARK

public static final EscapeUtil.EscapeToken QUESTION_MARK

ASTERISK

public static final EscapeUtil.EscapeToken ASTERISK

CURLY_BRCK_OPEN

public static final EscapeUtil.EscapeToken CURLY_BRCK_OPEN

CURLY_BRCK_CLOSE

public static final EscapeUtil.EscapeToken CURLY_BRCK_CLOSE

OPEN_BRCK

public static final EscapeUtil.EscapeToken OPEN_BRCK

CLS_BRCK

public static final EscapeUtil.EscapeToken CLS_BRCK

COMMA

public static final EscapeUtil.EscapeToken COMMA

AMPERSAND

public static final EscapeUtil.EscapeToken AMPERSAND

PLUS

public static final EscapeUtil.EscapeToken PLUS

AT_MRK

public static final EscapeUtil.EscapeToken AT_MRK

HASH_MRK

public static final EscapeUtil.EscapeToken HASH_MRK

SINGLE_PIPE

public static final EscapeUtil.EscapeToken SINGLE_PIPE

TILT_MRK

public static final EscapeUtil.EscapeToken TILT_MRK

PRCNTG_MRK

public static final EscapeUtil.EscapeToken PRCNTG_MRK

CAP_MRK

public static final EscapeUtil.EscapeToken CAP_MRK

Method Detail

values

public static EscapeUtil.EscapeToken[] 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 (EscapeUtil.EscapeToken c : EscapeUtil.EscapeToken.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static EscapeUtil.EscapeToken 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

targetString

public String targetString()

replacement

public String replacement()

restoreValue

public String restoreValue()

replacementFromString

public static String replacementFromString(String pStr)

Given a passed in string, returns what the replacement should be for escaping purposes. If not replacement is found, the passed in string is returned as is.

Parameters:

pStr - - pStr

Returns:

- TODO