Regex (ignition 7.9.4-beta1 API)

java.lang.Object
- com.inductiveautomation.snap.parse.Regex

```
public class Regex
extends java.lang.Object
```
A class for building regular expressions like a string buffer.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class Regex.Op

Nested Classes
Modifier and Type	Class and Description
`static class`	`Regex.Op`

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`Digit`
`static java.lang.String`	`LetterLower`
`static java.lang.String`	`LetterUpper`
`static java.lang.String`	`WhiteSpace`

Constructor Summary

Constructors
Constructor and Description
`Regex()` Creates a new regex.
`Regex(java.lang.String aName, java.lang.String aPattern)` Creates a new regex with given pattern and name.
`Regex(java.lang.String aName, java.lang.String aPattern, boolean isLiteral)` Creates a new regex with given pattern and name.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Regex`	`addAnyChar()` Adds any char (doesn't include newlines).
`Regex`	`addChar(char c)` Adds a literal char.
`void`	`addChars(java.lang.String... theParts)` Adds a letter.
`Regex`	`addDigit()` Adds a digit: [0-9].
`void`	`addGroup(Regex.Op anOp, java.lang.String... theParts)` Adds a group.
`Regex`	`addLetter()` Adds any letter.
`Regex`	`addLetterLower()` Adds any letter.
`Regex`	`addLetterUpper()` Adds any letter.
`Regex`	`addNonDigit()` Adds a non-digit: [^0-9].
`Regex`	`addNonWhitespace()` Adds non-whitespace char: [^\s].
`Regex`	`addNonWordCharacter()` Adds a non-word character: [^\w].
`Regex`	`addWhitespace()` Adds whitespace char [ \t\n\x0B\f\r].
`Regex`	`addWordCharacter()` Adds a word character: [a-zA-Z_0-9].
`char`	`getLiteralChar()` Returns the first literal in regex pattern (or 0 if not literal).
`static char`	`getLiteralChar(java.lang.String aPattern)` Returns the first char of a pattern, if it's a literal char.
`int`	`getLiteralLength()` Returns the literal length of this regex (the number of literal chars in the prefix).
`static int`	`getLiteralLength(java.lang.String aPattern)` Returns the literal length of pattern.
`java.util.regex.Matcher`	`getMatcher(java.lang.CharSequence anInput)` Returns the shared matcher (initialized to the given char sequence if not yet created).
`java.lang.String`	`getName()` Returns the regex name.
`java.lang.String`	`getPattern()` Returns the regex pattern.
`java.util.regex.Pattern`	`getPatternCompiled()` Returns the compiled pattern.
`int`	`getPatternCompileFlags()` Returns pattern compile flags.
`static boolean`	`isAncharChar(char c)` Utility method to return whether char is an anchor char.
`boolean`	`isLiteral()` Returns whether pattern is literal.
`static boolean`	`isSpecialChar(char c)` Utility method to return whether given character is a special char.
`void`	`setLiteral(boolean aFlag)` Sets whether pattern is literal.
`void`	`setName(java.lang.String aName)` Sets the regex name.
`void`	`setPattern(java.lang.String aPattern)` Sets the pattern.
`java.lang.String`	`toString()` Returns a string representation of regex.

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

- Field Detail
  - LetterLower
```
public static final java.lang.String LetterLower
```
    See Also:
    
    Constant Field Values
  - LetterUpper
```
public static final java.lang.String LetterUpper
```
    See Also:
    
    Constant Field Values
  - Digit
```
public static final java.lang.String Digit
```
    See Also:
    
    Constant Field Values
  - WhiteSpace
```
public static final java.lang.String WhiteSpace
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - Regex
```
public Regex()
```
    Creates a new regex.
  - Regex
```
public Regex(java.lang.String aName,
             java.lang.String aPattern)
```
    Creates a new regex with given pattern and name.
  - Regex
```
public Regex(java.lang.String aName,
             java.lang.String aPattern,
             boolean isLiteral)
```
    Creates a new regex with given pattern and name.
- Method Detail
  - getName
```
public java.lang.String getName()
```
    Returns the regex name.
  - setName
```
public void setName(java.lang.String aName)
```
    Sets the regex name.
  - getPattern
```
public java.lang.String getPattern()
```
    Returns the regex pattern.
  - setPattern
```
public void setPattern(java.lang.String aPattern)
```
    Sets the pattern.
  - isLiteral
```
public boolean isLiteral()
```
    Returns whether pattern is literal.
  - setLiteral
```
public void setLiteral(boolean aFlag)
```
    Sets whether pattern is literal.
  - getPatternCompiled
```
public java.util.regex.Pattern getPatternCompiled()
```
    Returns the compiled pattern.
  - getPatternCompileFlags
```
public int getPatternCompileFlags()
```
    Returns pattern compile flags.
  - getMatcher
```
public java.util.regex.Matcher getMatcher(java.lang.CharSequence anInput)
```
    Returns the shared matcher (initialized to the given char sequence if not yet created).
  - getLiteralLength
```
public int getLiteralLength()
```
    Returns the literal length of this regex (the number of literal chars in the prefix).
  - getLiteralChar
```
public char getLiteralChar()
```
    Returns the first literal in regex pattern (or 0 if not literal).
  - addGroup
```
public void addGroup(Regex.Op anOp,
                     java.lang.String... theParts)
```
    Adds a group.
  - addChars
```
public void addChars(java.lang.String... theParts)
```
    Adds a letter.
  - addChar
```
public Regex addChar(char c)
```
    Adds a literal char.
  - addLetter
```
public Regex addLetter()
```
    Adds any letter.
  - addLetterLower
```
public Regex addLetterLower()
```
    Adds any letter.
  - addLetterUpper
```
public Regex addLetterUpper()
```
    Adds any letter.
  - addAnyChar
```
public Regex addAnyChar()
```
    Adds any char (doesn't include newlines).
  - addDigit
```
public Regex addDigit()
```
    Adds a digit: [0-9].
  - addNonDigit
```
public Regex addNonDigit()
```
    Adds a non-digit: [^0-9].
  - addWhitespace
```
public Regex addWhitespace()
```
    Adds whitespace char [ \t\n\x0B\f\r].
  - addNonWhitespace
```
public Regex addNonWhitespace()
```
    Adds non-whitespace char: [^\s].
  - addWordCharacter
```
public Regex addWordCharacter()
```
    Adds a word character: [a-zA-Z_0-9].
  - addNonWordCharacter
```
public Regex addNonWordCharacter()
```
    Adds a non-word character: [^\w].
  - toString
```
public java.lang.String toString()
```
    Returns a string representation of regex.
    
    Overrides:
    
    toString in class java.lang.Object
  - isSpecialChar
```
public static boolean isSpecialChar(char c)
```
    Utility method to return whether given character is a special char.
  - isAncharChar
```
public static boolean isAncharChar(char c)
```
    Utility method to return whether char is an anchor char.
  - getLiteralLength
```
public static int getLiteralLength(java.lang.String aPattern)
```
    Returns the literal length of pattern.
  - getLiteralChar
```
public static char getLiteralChar(java.lang.String aPattern)
```
    Returns the first char of a pattern, if it's a literal char.

Class Regex

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

LetterLower

LetterUpper

Digit

WhiteSpace

Constructor Detail

Regex

Regex

Regex

Method Detail

getName

setName

getPattern

setPattern

isLiteral

setLiteral

getPatternCompiled

getPatternCompileFlags

getMatcher

getLiteralLength

getLiteralChar

addGroup

addChars

addChar

addLetter

addLetterLower

addLetterUpper

addAnyChar

addDigit

addNonDigit

addWhitespace

addNonWhitespace

addWordCharacter

addNonWordCharacter

toString

isSpecialChar

isAncharChar

getLiteralLength

getLiteralChar