Top Description Fields Constructors Methods

uk.ac.ed.ph.snuggletex.tokens

public final Class CommandToken

Class Inheritance

extends FlowToken

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

Imports

uk.ac.ed.ph.snuggletex.definitions.BuiltinCommand, .CommandType, .LaTeXMode, uk.ac.ed.ph.snuggletex.internal.FrozenSlice

This token represents a LaTeX BuiltinCommand.

Author: David McKain
Version: $Revision$

Field Summary

Modifier and Type	Field and Description
private final ArgumentContainerToken[]	arguments For `CommandType#COMPLEX`, this returns a possibly empty array of arguments.
private final ArgumentContainerToken	combinerTarget For `CommandType#COMBINER`, this returns the token(s) that the command is being combined with.
private final BuiltinCommand	command
private final ArgumentContainerToken	optionalArgument For `CommandType#COMPLEX`, this returns the optional argument or null if nothing was provided.

Inherited from uk.ac.ed.ph.snuggletex.tokens.FlowToken:: textFlowContext

Constructor Summary

Access	Constructor and Description
public	CommandToken(final FrozenSlice slice, final LaTeXMode latexMode, final BuiltinCommand command)
public	CommandToken(final FrozenSlice slice, final LaTeXMode latexMode, final BuiltinCommand command, final ArgumentContainerToken combinerTarget)
public	CommandToken(final FrozenSlice slice, final LaTeXMode latexMode, final BuiltinCommand command, final ArgumentContainerToken optionalArgument, final ArgumentContainerToken[] arguments)
private	CommandToken(final FrozenSlice slice, final LaTeXMode latexMode, final BuiltinCommand command, final ArgumentContainerToken combinerTarget, final ArgumentContainerToken optionalArgument, final ArgumentContainerToken[] arguments)

Method Summary

Modifier and Type	Method and Description
public ArgumentContainerToken[]	getArguments()
public ArgumentContainerToken	getCombinerTarget()
public BuiltinCommand	getCommand()
public ArgumentContainerToken	getOptionalArgument()

Inherited from uk.ac.ed.ph.snuggletex.tokens.FlowToken:: getTextFlowContext

Field Detail

arguments	back to summary
private final ArgumentContainerToken[] arguments For `CommandType#COMPLEX`, this returns a possibly empty array of arguments. Otherwise, null is returned.

combinerTarget	back to summary
private final ArgumentContainerToken combinerTarget For `CommandType#COMBINER`, this returns the token(s) that the command is being combined with.

command	back to summary
private final BuiltinCommand command

optionalArgument	back to summary
private final ArgumentContainerToken optionalArgument For `CommandType#COMPLEX`, this returns the optional argument or null if nothing was provided.

Constructor Detail

CommandToken	back to summary
public CommandToken(final FrozenSlice slice, final LaTeXMode latexMode, final BuiltinCommand command)

CommandToken	back to summary
public CommandToken(final FrozenSlice slice, final LaTeXMode latexMode, final BuiltinCommand command, final ArgumentContainerToken combinerTarget)

CommandToken	back to summary
public CommandToken(final FrozenSlice slice, final LaTeXMode latexMode, final BuiltinCommand command, final ArgumentContainerToken optionalArgument, final ArgumentContainerToken[] arguments)

CommandToken	back to summary
private CommandToken(final FrozenSlice slice, final LaTeXMode latexMode, final BuiltinCommand command, final ArgumentContainerToken combinerTarget, final ArgumentContainerToken optionalArgument, final ArgumentContainerToken[] arguments)

Method Detail

getArguments	back to summary
public ArgumentContainerToken[] getArguments()

getCombinerTarget	back to summary
public ArgumentContainerToken getCombinerTarget()

getCommand	back to summary
public BuiltinCommand getCommand()

getOptionalArgument	back to summary
public ArgumentContainerToken getOptionalArgument()