antlr
Class ImportVocabTokenManager

java.lang.Object
  |
  +--antlr.SimpleTokenManager
        |
        +--antlr.ImportVocabTokenManager

All Implemented Interfaces:

Cloneable, TokenManager

class ImportVocabTokenManager

extends SimpleTokenManager

implements Cloneable

Static implementation of the TokenManager, used for importVocab option

Field Summary

private String	filename
protected Grammar	grammar
protected int	maxToken
protected String	name
protected boolean	readOnly
protected Tool	tool
protected Vector	vocabulary

Constructor Summary

(package private)

ImportVocabTokenManager(Grammar grammar, String filename_, String name_, Tool tool_)

Method Summary

Object	clone() Creates and returns a copy of this object.
void	define(String s, int ttype) define a token.
void	define(TokenSymbol ts) define a token.
String	getName() Simple token manager doesn't have a name -- must be set externally
String	getTokenStringAt(int idx) Get a token symbol by index
TokenSymbol	getTokenSymbol(String sym) Get the TokenSymbol for a string
TokenSymbol	getTokenSymbolAt(int idx) Get a token symbol by index
Enumeration	getTokenSymbolElements() Get an enumerator over the symbol table
Enumeration	getTokenSymbolKeys()
Vector	getVocabulary() Get the token vocabulary (read-only).
boolean	isReadOnly() importVocab token manager is read-only if output would be same as input
void	mapToTokenSymbol(String name, TokenSymbol sym) Map a label or string to an existing token symbol
int	maxTokenType() Get the highest token type in use
int	nextTokenType() Get the next unused token type.
void	setName(String name_) Set the name of the token manager
void	setReadOnly(boolean ro)
boolean	tokenDefined(String symbol) Is a token symbol defined?

Methods inherited from class java.lang.Object

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

Field Detail

filename

private String filename

grammar

protected Grammar grammar

maxToken

protected int maxToken

vocabulary

protected Vector vocabulary

tool

protected Tool tool

name

protected String name

readOnly

protected boolean readOnly

Constructor Detail

ImportVocabTokenManager

ImportVocabTokenManager(Grammar grammar,
                        String filename_,
                        String name_,
                        Tool tool_)

Method Detail

clone

public Object clone()

Description copied from class: Object

Creates and returns a copy of this object. The precise meaning of "copy" may depend on the class of the object. The general intent is that, for any object x, the expression:

 x.clone() != x

will be true, and that the expression:

 x.clone().getClass() == x.getClass()

will be true, but these are not absolute requirements. While it is typically the case that:

 x.clone().equals(x)

will be true, this is not an absolute requirement.

By convention, the returned object should be obtained by calling super.clone. If a class and all of its superclasses (except Object) obey this convention, it will be the case that x.clone().getClass() == x.getClass().

By convention, the object returned by this method should be independent of this object (which is being cloned). To achieve this independence, it may be necessary to modify one or more fields of the object returned by super.clone before returning it. Typically, this means copying any mutable objects that comprise the internal "deep structure" of the object being cloned and replacing the references to these objects with references to the copies. If a class contains only primitive fields or references to immutable objects, then it is usually the case that no fields in the object returned by super.clone need to be modified.

The method clone for class Object performs a specific cloning operation. First, if the class of this object does not implement the interface Cloneable, then a CloneNotSupportedException is thrown. Note that all arrays are considered to implement the interface Cloneable. Otherwise, this method creates a new instance of the class of this object and initializes all its fields with exactly the contents of the corresponding fields of this object, as if by assignment; the contents of the fields are not themselves cloned. Thus, this method performs a "shallow copy" of this object, not a "deep copy" operation.

The class Object does not itself implement the interface Cloneable, so calling the clone method on an object whose class is Object will result in throwing an exception at run time.

Specified by:

clone in interface TokenManager

Overrides:

clone in class SimpleTokenManager

Returns:

a clone of this instance.

See Also:

java.lang.Cloneable

define

public void define(TokenSymbol ts)

define a token.

Specified by:

define in interface TokenManager

Overrides:

define in class SimpleTokenManager

define

public void define(String s,
                   int ttype)

define a token. Intended for use only when reading the importVocab file.

isReadOnly

public boolean isReadOnly()

importVocab token manager is read-only if output would be same as input

Specified by:

isReadOnly in interface TokenManager

Overrides:

isReadOnly in class SimpleTokenManager

nextTokenType

public int nextTokenType()

Get the next unused token type.

Specified by:

nextTokenType in interface TokenManager

Overrides:

nextTokenType in class SimpleTokenManager

getName

public String getName()

Simple token manager doesn't have a name -- must be set externally

Specified by:

getName in interface TokenManager

getTokenStringAt

public String getTokenStringAt(int idx)

Get a token symbol by index

Specified by:

getTokenStringAt in interface TokenManager

getTokenSymbol

public TokenSymbol getTokenSymbol(String sym)

Get the TokenSymbol for a string

Specified by:

getTokenSymbol in interface TokenManager

getTokenSymbolAt

public TokenSymbol getTokenSymbolAt(int idx)

Get a token symbol by index

Specified by:

getTokenSymbolAt in interface TokenManager

getTokenSymbolElements

public Enumeration getTokenSymbolElements()

Get an enumerator over the symbol table

Specified by:

getTokenSymbolElements in interface TokenManager

getTokenSymbolKeys

public Enumeration getTokenSymbolKeys()

Specified by:

getTokenSymbolKeys in interface TokenManager

getVocabulary

public Vector getVocabulary()

Get the token vocabulary (read-only).

Specified by:

getVocabulary in interface TokenManager

Returns:

A Vector of TokenSymbol

mapToTokenSymbol

public void mapToTokenSymbol(String name,
                             TokenSymbol sym)

Map a label or string to an existing token symbol

Specified by:

mapToTokenSymbol in interface TokenManager

maxTokenType

public int maxTokenType()

Get the highest token type in use

Specified by:

maxTokenType in interface TokenManager

setName

public void setName(String name_)

Set the name of the token manager

Specified by:

setName in interface TokenManager

setReadOnly

public void setReadOnly(boolean ro)

Specified by:

setReadOnly in interface TokenManager

tokenDefined

public boolean tokenDefined(String symbol)

Is a token symbol defined?

Specified by:

tokenDefined in interface TokenManager