JavaHighlighter (JHighlight 1.1.0 API)

java.lang.Object
- org.codelibs.jhighlight.highlighter.JavaHighlighter

All Implemented Interfaces:

ExplicitStateHighlighter
```
public class JavaHighlighter
extends Object
implements ExplicitStateHighlighter
```
This class is a scanner generated by JFlex 1.4.1 on 8/2/06 6:03 AM from the specification file com/uwyn/jhighlight/highlighter/JavaHighlighter.flex

Field Summary

Fields
Modifier and Type	Field and Description
`static boolean`	`ASSERT_IS_KEYWORD`
`static int`	`IN_COMMENT`
`static int`	`IN_JAVA_DOC_COMMENT`
`static byte`	`JAVA_COMMENT_STYLE`
`static byte`	`JAVADOC_COMMENT_STYLE`
`static byte`	`JAVADOC_TAG_STYLE`
`static byte`	`KEYWORD_STYLE`
`static byte`	`LITERAL_STYLE`
`static byte`	`OPERATOR_STYLE`
`static byte`	`PLAIN_STYLE`
`static byte`	`SEPARATOR_STYLE`
`static byte`	`TYPE_STYLE`
`static int`	`YYEOF` This character denotes the end of file
`static int`	`YYINITIAL` lexical states

Constructor Summary

Constructors
Constructor and Description
`JavaHighlighter()`
`JavaHighlighter(InputStream in)` Creates a new scanner.
`JavaHighlighter(Reader in)` Creates a new scanner There is also a java.io.InputStream version of this constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`byte`	`getCurrentState()`
`byte`	`getNextToken()` Obtain the next token from the scanner.
`byte`	`getStartState()`
`int`	`getStyleCount()`
`int`	`getTokenLength()` Returns the length of the matched text region.
`void`	`setReader(Reader r)` Sets the reader that will be used to receive the text data.
`void`	`setState(byte newState)`
`void`	`yybegin(int newState)` Enters a new lexical state
`char`	`yycharat(int pos)` Returns the character at position `pos` from the matched text.
`void`	`yyclose()` Closes the input stream.
`int`	`yylength()` Returns the length of the matched text region.
`int`	`yylex()` Resumes scanning until the next regular expression is matched, the end of input is encountered or an I/O-Error occurs.
`void`	`yypushback(int number)` Pushes the specified amount of characters back into the input stream.
`void`	`yyreset(Reader reader)` Resets the scanner to read from a new input stream.
`int`	`yystate()` Returns the current lexical state.
`String`	`yytext()` Returns the text matched by the current regular expression.

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

- Field Detail
  - YYEOF
```
public static final int YYEOF
```
    This character denotes the end of file
    
    See Also:
    
    Constant Field Values
  - YYINITIAL
```
public static final int YYINITIAL
```
    lexical states
    
    See Also:
    
    Constant Field Values
  - IN_COMMENT
```
public static final int IN_COMMENT
```
    See Also:
    
    Constant Field Values
  - IN_JAVA_DOC_COMMENT
```
public static final int IN_JAVA_DOC_COMMENT
```
    See Also:
    
    Constant Field Values
  - ASSERT_IS_KEYWORD
```
public static boolean ASSERT_IS_KEYWORD
```
  - PLAIN_STYLE
```
public static final byte PLAIN_STYLE
```
    See Also:
    
    Constant Field Values
  - KEYWORD_STYLE
```
public static final byte KEYWORD_STYLE
```
    See Also:
    
    Constant Field Values
  - TYPE_STYLE
```
public static final byte TYPE_STYLE
```
    See Also:
    
    Constant Field Values
  - OPERATOR_STYLE
```
public static final byte OPERATOR_STYLE
```
    See Also:
    
    Constant Field Values
  - SEPARATOR_STYLE
```
public static final byte SEPARATOR_STYLE
```
    See Also:
    
    Constant Field Values
  - LITERAL_STYLE
```
public static final byte LITERAL_STYLE
```
    See Also:
    
    Constant Field Values
  - JAVA_COMMENT_STYLE
```
public static final byte JAVA_COMMENT_STYLE
```
    See Also:
    
    Constant Field Values
  - JAVADOC_COMMENT_STYLE
```
public static final byte JAVADOC_COMMENT_STYLE
```
    See Also:
    
    Constant Field Values
  - JAVADOC_TAG_STYLE
```
public static final byte JAVADOC_TAG_STYLE
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - JavaHighlighter
```
public JavaHighlighter()
```
  - JavaHighlighter
```
public JavaHighlighter(Reader in)
```
    Creates a new scanner There is also a java.io.InputStream version of this constructor.
    
    Parameters:
    
    in - the java.io.Reader to read input from.
  - JavaHighlighter
```
public JavaHighlighter(InputStream in)
```
    Creates a new scanner. There is also java.io.Reader version of this constructor.
    
    Parameters:
    
    in - the java.io.Inputstream to read input from.
- Method Detail
  - getStyleCount
```
public int getStyleCount()
```
  - getStartState
```
public byte getStartState()
```
  - getCurrentState
```
public byte getCurrentState()
```
  - setState
```
public void setState(byte newState)
```
  - getNextToken
```
public byte getNextToken()
                  throws IOException
```
    Description copied from interface: ExplicitStateHighlighter
    
    Obtain the next token from the scanner.
    
    Specified by:
    
    getNextToken in interface ExplicitStateHighlighter
    
    Returns:
    
    one of the tokens that are define in the scanner
    
    Throws:
    
    IOException - when an error occurred during the parsing of the reader
  - getTokenLength
```
public int getTokenLength()
```
    Description copied from interface: ExplicitStateHighlighter
    
    Returns the length of the matched text region.
    
    Specified by:
    
    getTokenLength in interface ExplicitStateHighlighter
    
    Returns:
    
    the length of the matched text region
  - setReader
```
public void setReader(Reader r)
```
    Description copied from interface: ExplicitStateHighlighter
    
    Sets the reader that will be used to receive the text data.
    
    Specified by:
    
    setReader in interface ExplicitStateHighlighter
    
    Parameters:
    
    r - the Reader that has to be used
  - yyclose
```
public final void yyclose()
                   throws IOException
```
    Closes the input stream.
    
    Throws:
    
    IOException
  - yyreset
```
public final void yyreset(Reader reader)
```
    Resets the scanner to read from a new input stream. Does not close the old reader. All internal variables are reset, the old input stream cannot be reused (internal buffer is discarded and lost). Lexical state is set to ZZ_INITIAL.
    
    Parameters:
    
    reader - the new input stream
  - yystate
```
public final int yystate()
```
    Returns the current lexical state.
  - yybegin
```
public final void yybegin(int newState)
```
    Enters a new lexical state
    
    Parameters:
    
    newState - the new lexical state
  - yytext
```
public final String yytext()
```
    Returns the text matched by the current regular expression.
  - yycharat
```
public final char yycharat(int pos)
```
    Returns the character at position pos from the matched text. It is equivalent to yytext().charAt(pos), but faster
    
    Parameters:
    
    pos - the position of the character to fetch. A value from 0 to yylength()-1.
    
    Returns:
    
    the character at position pos
  - yylength
```
public final int yylength()
```
    Returns the length of the matched text region.
  - yypushback
```
public void yypushback(int number)
```
    Pushes the specified amount of characters back into the input stream. They will be read again by then next call of the scanning method
    
    Parameters:
    
    number - the number of characters to be read again. This number must not be greater than yylength()!
  - yylex
```
public int yylex()
          throws IOException
```
    Resumes scanning until the next regular expression is matched, the end of input is encountered or an I/O-Error occurs.
    
    Returns:
    
    the next token
    
    Throws:
    
    IOException - if any I/O-Error occurs

Class JavaHighlighter

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

YYEOF

YYINITIAL

IN_COMMENT

IN_JAVA_DOC_COMMENT

ASSERT_IS_KEYWORD

PLAIN_STYLE

KEYWORD_STYLE

TYPE_STYLE

OPERATOR_STYLE

SEPARATOR_STYLE

LITERAL_STYLE

JAVA_COMMENT_STYLE

JAVADOC_COMMENT_STYLE

JAVADOC_TAG_STYLE

Constructor Detail

JavaHighlighter

JavaHighlighter

JavaHighlighter

Method Detail

getStyleCount

getStartState

getCurrentState

setState

getNextToken

getTokenLength

setReader

yyclose

yyreset

yystate

yybegin

yytext

yycharat

yylength

yypushback

yylex