Top Description Fields Constructors Methods

uk.ac.ed.ph.snuggletex.tokens

public abstract Class Token

Class Inheritance

extends Object

java.lang.Object
uk.ac.ed.ph.snuggletex.tokens.Token

Known Direct Subclasses

uk.ac.ed.ph.snuggletex.tokens.ArgumentContainerToken, uk.ac.ed.ph.snuggletex.tokens.FlowToken, uk.ac.ed.ph.snuggletex.tokens.RootToken

Imports

uk.ac.ed.ph.snuggletex.SnugglePackage, uk.ac.ed.ph.snuggletex.definitions.BuiltinCommand, .BuiltinEnvironment, .ComputedStyle, .LaTeXMode, .MathCharacter, uk.ac.ed.ph.snuggletex.internal.FrozenSlice, uk.ac.ed.ph.snuggletex.internal.util.DumpMode, .ObjectDumperOptions, .ObjectUtilities, uk.ac.ed.ph.snuggletex.semantics.Interpretation, .InterpretationType, .MathCharacterInterpretation, java.util.EnumMap

Base interface for a parsed SnuggleTeX token.

Author: David McKain
Version: $Revision$

Field Summary

Modifier and Type	Field and Description
protected ComputedStyle	computedStyle
protected final EnumMap<InterpretationType, Interpretation>	interpretationMap Interpretation(s) of this token, if it can be readily deduced from the input.
protected final LaTeXMode	latexMode LaTeX Mode that this token was parsed in
protected final FrozenSlice	slice Extent of this entire token
protected final TokenType	type Classifies the token

Constructor Summary

Access	Constructor and Description
protected	Token(final FrozenSlice slice, final TokenType type, final LaTeXMode latexMode, final Interpretation... interpretations)
protected	Token(final FrozenSlice slice, final TokenType type, final LaTeXMode latexMode, final EnumMap<InterpretationType, Interpretation> interpretationMap)

Method Summary

Modifier and Type	Method and Description
public ComputedStyle	getComputedStyle()
public Interpretation	getInterpretation(InterpretationType type)
public EnumMap<InterpretationType, Interpretation>	getInterpretationMap()
public LaTeXMode	getLatexMode()
public MathCharacter	getMathCharacter()
public int	getMathCharacterCodePoint()
public FrozenSlice	getSlice()
public TokenType	getType()
public boolean	hasInterpretationType(InterpretationType... types)
public boolean	isCommand(BuiltinCommand command)
public boolean	isEnvironment(BuiltinEnvironment environment)
public void	setComputedStyle(ComputedStyle computedStyle)
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll wait wait wait

Field Detail

computedStyle	back to summary
protected ComputedStyle computedStyle

interpretationMap	back to summary
protected final EnumMap<InterpretationType, Interpretation> interpretationMap Interpretation(s) of this token, if it can be readily deduced from the input. May be null.

latexMode	back to summary
protected final LaTeXMode latexMode LaTeX Mode that this token was parsed in

slice	back to summary
protected final FrozenSlice slice Extent of this entire token

type	back to summary
protected final TokenType type Classifies the token

Constructor Detail

Token	back to summary
protected Token(final FrozenSlice slice, final TokenType type, final LaTeXMode latexMode, final Interpretation... interpretations)

Token	back to summary
protected Token(final FrozenSlice slice, final TokenType type, final LaTeXMode latexMode, final EnumMap<InterpretationType, Interpretation> interpretationMap)

Method Detail

getComputedStyle	back to summary
public ComputedStyle getComputedStyle()

getInterpretation	back to summary
public Interpretation getInterpretation(InterpretationType type)

getInterpretationMap	back to summary
public EnumMap<InterpretationType, Interpretation> getInterpretationMap() Annotations @ObjectDumperOptions:TO_STRING

getLatexMode	back to summary
public LaTeXMode getLatexMode()

getMathCharacter	back to summary
public MathCharacter getMathCharacter()

getMathCharacterCodePoint	back to summary
public int getMathCharacterCodePoint()

getSlice	back to summary
public FrozenSlice getSlice() Annotations @ObjectDumperOptions:TO_STRING

getType	back to summary
public TokenType getType()

hasInterpretationType	back to summary
public boolean hasInterpretationType(InterpretationType... types)

isCommand	back to summary
public boolean isCommand(BuiltinCommand command)

isEnvironment	back to summary
public boolean isEnvironment(BuiltinEnvironment environment)

setComputedStyle	back to summary
public void setComputedStyle(ComputedStyle computedStyle)

toString back to summary

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Annotations

@Override