TroffXref

java.lang.Object
- org.opensolaris.opengrok.analysis.JFlexXref
- - org.opensolaris.opengrok.analysis.document.TroffXref

```
public class TroffXref
extends JFlexXref
```
This class is a scanner generated by JFlex 1.4.3 on 10/28/13 12:18 PM from the specification file /builddir/build/BUILD/opengrok-0.11.1-src/src/org/opensolaris/opengrok/analysis/document/TroffXref.lex

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`BOLD`
`static int`	`COMMENT`
`static int`	`HEADER`
`static int`	`TBL`
`static int`	`TBLL`
`static int`	`YYEOF` This character denotes the end of file
`static int`	`YYINITIAL` lexical states

Fields inherited from class org.opensolaris.opengrok.analysis.JFlexXref
annotation, defs, out, project, urlPrefix, userPageLink, userPageSuffix

Constructor Summary

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

Method Summary

Methods
Modifier and Type	Method and Description
`protected void`	`cleanup()`
`protected void`	`closeDiv()`
`protected void`	`closePara()`
`protected void`	`closeSpan()`
`protected int`	`getLineNumber()` Get the value of `yyline`.
`protected void`	`openDiv(java.lang.String cssClass)`
`protected void`	`openPara()`
`protected void`	`openSpan(char cssClass)`
`protected void`	`setLineNumber(int x)` Set the value of `yyline`.
`void`	`write(java.io.Writer out)` Write xref to the specified `Writer`.
`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(java.io.Reader reader)` Resets the scanner to read from a new input stream.
`int`	`yystate()` Returns the current lexical state.
`java.lang.String`	`yytext()` Returns the text matched by the current regular expression.

Methods inherited from class org.opensolaris.opengrok.analysis.JFlexXref
appendProject, getProjectPostfix, reInit, setDefs, startNewLine, writeEMailAddress, writeSymbol, writeUnicodeChar

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
  - TBL
```
public static final int TBL
```
    See Also:
    Constant Field Values
  - COMMENT
```
public static final int COMMENT
```
    See Also:
    Constant Field Values
  - HEADER
```
public static final int HEADER
```
    See Also:
    Constant Field Values
  - BOLD
```
public static final int BOLD
```
    See Also:
    Constant Field Values
  - TBLL
```
public static final int TBLL
```
    See Also:
    Constant Field Values
- Constructor Detail
  - TroffXref
```
public TroffXref(java.io.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.
  - TroffXref
```
public TroffXref(java.io.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
  - write
```
public void write(java.io.Writer out)
           throws java.io.IOException
```
    Description copied from class: JFlexXref
    
    Write xref to the specified Writer.
    
    Overrides:
    
    write in class JFlexXref
    
    Parameters:
    out - xref destination
    
    Throws:
    
    java.io.IOException - on error when writing the xref
  - getLineNumber
```
protected int getLineNumber()
```
    Description copied from class: JFlexXref
    
    Get the value of yyline.
    
    Specified by:
    
    getLineNumber in class JFlexXref
  - setLineNumber
```
protected void setLineNumber(int x)
```
    Description copied from class: JFlexXref
    
    Set the value of yyline.
    
    Specified by:
    
    setLineNumber in class JFlexXref
  - closePara
```
protected void closePara()
                  throws java.io.IOException
```
    Throws:
    
    java.io.IOException
  - closeSpan
```
protected void closeSpan()
                  throws java.io.IOException
```
    Throws:
    
    java.io.IOException
  - closeDiv
```
protected void closeDiv()
                 throws java.io.IOException
```
    Throws:
    
    java.io.IOException
  - openPara
```
protected void openPara()
                 throws java.io.IOException
```
    Throws:
    
    java.io.IOException
  - openSpan
```
protected void openSpan(char cssClass)
                 throws java.io.IOException
```
    Throws:
    
    java.io.IOException
  - openDiv
```
protected void openDiv(java.lang.String cssClass)
                throws java.io.IOException
```
    Throws:
    
    java.io.IOException
  - cleanup
```
protected void cleanup()
```
  - yyclose
```
public final void yyclose()
                   throws java.io.IOException
```
    Closes the input stream.
    
    Throws:
    
    java.io.IOException
  - yyreset
```
public final void yyreset(java.io.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.
    
    Specified by:
    
    yyreset in class JFlexXref
    
    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 java.lang.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 java.io.IOException
```
    Resumes scanning until the next regular expression is matched, the end of input is encountered or an I/O-Error occurs.
    
    Specified by:
    
    yylex in class JFlexXref
    
    Returns:
    the next token
    
    Throws:
    
    java.io.IOException - if any I/O-Error occurs

Class TroffXref

Field Summary

Fields inherited from class org.opensolaris.opengrok.analysis.JFlexXref

Constructor Summary

Method Summary

Methods inherited from class org.opensolaris.opengrok.analysis.JFlexXref

Methods inherited from class java.lang.Object

Field Detail

YYEOF

YYINITIAL

TBL

COMMENT

HEADER

BOLD

TBLL

Constructor Detail

TroffXref

TroffXref

Method Detail

write

getLineNumber

setLineNumber

closePara

closeSpan

closeDiv

openPara

openSpan

openDiv

cleanup

yyclose

yyreset

yystate

yybegin

yytext

yycharat

yylength

yypushback

yylex