ParserState (diffparser 1.2 API)

java.lang.Object
- java.lang.Enum<ParserState>
- - org.wickedsource.diffparser.unified.ParserState

All Implemented Interfaces:

Serializable, Comparable<ParserState>
```
public enum ParserState
extends Enum<ParserState>
```
State machine for a parser parsing a unified diff.

Author:

Tom Hombergs

Enum Constant Summary

Enum Constants
Enum Constant and Description
`END` The parser is in this state if it is currently parsing a line that is the delimiter between two Diffs.
`FROM_FILE` The parser is in this state if it is currently parsing the line containing the "from" file.
`FROM_LINE` The parser is in this state if it is currently parsing a line containing a line that is in the first file, but not the second (a "from" line).
`HEADER` The parser is in this state if it is currently parsing a header line.
`HUNK_START` The parser is in this state if it is currently parsing a line containing the header of a hunk.
`INITIAL` This is the initial state of the parser.
`NEUTRAL_LINE` The parser is in this state if it is currently parsing a line that is contained in both files (a "neutral" line).
`TO_FILE` The parser is in this state if it is currently parsing the line containing the "to" file.
`TO_LINE` The parser is in this state if it is currently parsing a line containing a line that is in the second file, but not the first (a "to" line).

Field Summary

Fields
Modifier and Type Field and Description

protected static org.slf4j.Logger logger

Fields
Modifier and Type	Field and Description
`protected static org.slf4j.Logger`	`logger`

Method Summary

Methods
Modifier and Type	Method and Description
`protected void`	`logTransition(String currentLine, ParserState fromState, ParserState toState)`
`protected boolean`	`matchesEndPattern(String line, ParseWindow window)`
`protected boolean`	`matchesFromFilePattern(String line)`
`protected boolean`	`matchesFromLinePattern(String line)`
`protected boolean`	`matchesHunkStartPattern(String line)`
`protected boolean`	`matchesToFilePattern(String line)`
`protected boolean`	`matchesToLinePattern(String line)`
`abstract ParserState`	`nextState(ParseWindow window)` Returns the next state of the state machine depending on the current state and the content of a window of lines around the line that is currently being parsed.
`static ParserState`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static ParserState[]`	`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
  - INITIAL
```
public static final ParserState INITIAL
```
    This is the initial state of the parser.
  - HEADER
```
public static final ParserState HEADER
```
    The parser is in this state if it is currently parsing a header line.
  - FROM_FILE
```
public static final ParserState FROM_FILE
```
    The parser is in this state if it is currently parsing the line containing the "from" file.
    Example line:
    --- /path/to/file.txt
  - TO_FILE
```
public static final ParserState TO_FILE
```
    The parser is in this state if it is currently parsing the line containing the "to" file.
    Example line:
    +++ /path/to/file.txt
  - HUNK_START
```
public static final ParserState HUNK_START
```
    The parser is in this state if it is currently parsing a line containing the header of a hunk.
    Example line:
    @@ -1,5 +2,6 @@
  - FROM_LINE
```
public static final ParserState FROM_LINE
```
    The parser is in this state if it is currently parsing a line containing a line that is in the first file, but not the second (a "from" line).
    Example line:
    - only the dash at the start is important
  - TO_LINE
```
public static final ParserState TO_LINE
```
    The parser is in this state if it is currently parsing a line containing a line that is in the second file, but not the first (a "to" line).
    Example line:
    + only the plus at the start is important
  - NEUTRAL_LINE
```
public static final ParserState NEUTRAL_LINE
```
    The parser is in this state if it is currently parsing a line that is contained in both files (a "neutral" line). This line can contain any string.
  - END
```
public static final ParserState END
```
    The parser is in this state if it is currently parsing a line that is the delimiter between two Diffs. This line is always a new line.
- Field Detail
  - logger
```
protected static org.slf4j.Logger logger
```
- Method Detail
  - values
```
public static ParserState[] 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 (ParserState c : ParserState.values())
    System.out.println(c);
```
    Returns:
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static ParserState 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
  - nextState
```
public abstract ParserState nextState(ParseWindow window)
```
    Returns the next state of the state machine depending on the current state and the content of a window of lines around the line that is currently being parsed.
    
    Parameters:
    window - the window around the line currently being parsed.
    
    Returns:
    the next state of the state machine.
  - logTransition
```
protected void logTransition(String currentLine,
                 ParserState fromState,
                 ParserState toState)
```
  - matchesFromFilePattern
```
protected boolean matchesFromFilePattern(String line)
```
  - matchesToFilePattern
```
protected boolean matchesToFilePattern(String line)
```
  - matchesFromLinePattern
```
protected boolean matchesFromLinePattern(String line)
```
  - matchesToLinePattern
```
protected boolean matchesToLinePattern(String line)
```
  - matchesHunkStartPattern
```
protected boolean matchesHunkStartPattern(String line)
```
  - matchesEndPattern
```
protected boolean matchesEndPattern(String line,
                        ParseWindow window)
```

Enum ParserState

Enum Constant Summary

Field Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

INITIAL

HEADER

FROM_FILE

TO_FILE

HUNK_START

FROM_LINE

TO_LINE

NEUTRAL_LINE

END

Field Detail

logger

Method Detail

values

valueOf

nextState

logTransition

matchesFromFilePattern

matchesToFilePattern

matchesFromLinePattern

matchesToLinePattern

matchesHunkStartPattern

matchesEndPattern