Package org.apache.tika.parser.microsoft.rtf.jflex

Class RTFToken

java.lang.Object

org.apache.tika.parser.microsoft.rtf.jflex.RTFToken

public class RTFToken
extends Object

A single token produced by the RTF tokenizer.

Mutable and reused by the tokenizer to avoid allocation in the hot loop. Consumers must copy any data they need before requesting the next token.

For TEXT and CONTROL_SYMBOL tokens (single character), use getChar() to avoid String allocation. For CONTROL_WORD tokens, use getName().

Constructor Summary

Constructors

Constructor	Description
RTFToken()

Method Summary

Modifier and Type	Method	Description
char	getChar()	For TEXT and CONTROL_SYMBOL tokens: the single character, without allocating a String.
int	getHexValue()
String	getName()	For CONTROL_WORD tokens: the control word name.
int	getParameter()
RTFTokenType	getType()
boolean	hasParameter()
void	reset(RTFTokenType type)
void	set(RTFTokenType type, String name, int parameter, boolean hasParameter)
void	setChar(RTFTokenType type, char ch)
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

RTFToken

public RTFToken()

Method Details

reset

public void reset(RTFTokenType type)

set

public void set(RTFTokenType type,
 String name,
 int parameter,
 boolean hasParameter)

setChar

public void setChar(RTFTokenType type,
 char ch)

getType

public RTFTokenType getType()

getName

public String getName()

For CONTROL_WORD tokens: the control word name.

getChar

public char getChar()

For TEXT and CONTROL_SYMBOL tokens: the single character, without allocating a String.

getParameter

public int getParameter()

hasParameter

public boolean hasParameter()

getHexValue

public int getHexValue()

toString

public String toString()

Overrides:

toString in class Object