Follow the links below to browse sample Javadoc for MJ classes and tools, including the MJ Runtime Library.

 

Package: com.arsi.mj.maprpt.lexer.tokens.cmd  previous next contents

Package com.arsi.mj.maprpt.lexer.tokens.cmd contains the following classes and interfaces.
Classes and Interfaces
AlphanumStringToken Represents a string of alpha numeric characters, including the underscore character.
AmpersandToken Represents & ampersand character used to indicate Mapper AND operation in certain contexts and as literal text in other cases.
AsteriskToken Represents * asterisk character used to indicate Mapper global variables and mathematical operations in certain contexts and as literal text in other cases.
BlankToken Represents blank (i.e., space) character used to separate Mapper arguments and commands, or as literal text.
ColonToken Represents : colon character used to delimit Mapper labels and as literal text in other cases.
CommandTokenBase Base class that provides for common attributes of command tokens, all "true" concrete content token implementations derive from this class.
CommaToken Represents , comma character used to separate Mapper arguments in most lexical contexts, and as literal text in other cases.
DollarToken Represents $ dollar sign character used to indicate Mapper environment variables and reserved words in certain contexts, and as literal text in other cases.
EqualToken Represents = equal-sign character used to indicate Mapper variable initialization or comparison.
FloatDigitsToken Represents a set of digits suitable as a floating point literal.
GreaterThanToken Represents > greater-than character used to indicate Mapper named variable or comparison.
HyphenToken Represents - hyphen character used to indicate a negative number or subtraction in certain lexical contexts, and as literal text in other cases.
IntegerDigitsToken Represents a set of digits suitable as an integer literal.
LeftBracketToken Represents [ left bracket character used to indicate Mapper array elements in certain contexts and as literal text in other cases.
LeftParenthesisToken Represents ( left parenthesis character used to indicate Mapper substring range or operator precedences in certain contexts, and as literal text in other cases.
LessThanToken Represents < less-than character used to indicate Mapper named variable or comparison.
OtherToken Catch-all command token that represents an "other" character that has no special contextual meaning to the command token lexer (but may have meaning to a parser built on top of the lexer).
PeriodToken Represents the period that terminates all commands in an at-sign line, and includes an optional comment that follows the period (e.g., "@. this is a comment").
PlusToken Represents + plus character used to indicate a positive number or addition in certain lexical contexts, and as literal text in other cases.
QuotedStringToken Represents a string of characters enclosed in single quotes (or apostrophes to use Mapper terminology).
RightBracketToken Represents ] right bracket character used to indicate Mapper array elements in certain contexts and as literal text in other cases.
RightParenthesisToken Represents ) right parenthesis character used to indicate Mapper substring range or operator precedences in certain contexts, and as literal text in other cases.
ScientificDigitsToken Represents a set of digits suitable as a scientific notation literal.
SemicolonToken Represents ; semicolon character used to separate Mapper expressions in certain lexical contexts, and as literal text in other cases.
SlashToken Represents / forward slash character used to separate parameters or division in certain lexical contexts, and as literal text in other cases.

Class: AlphanumStringToken   next package

Represents a string of alpha numeric characters, including the underscore character.
Treat as "thread-safe", since immutable once created.
public class com.arsi.mj.maprpt.lexer.tokens.cmd.AlphanumStringToken
  extends com.arsi.mj.maprpt.lexer.tokens.cmd.CommandTokenBase
Constructors
public AlphanumStringToken(com.arsi.mj.maprpt.parser.line.types.AtLine aLine, java.lang.String aString, int anIndex, int aLength)
Methods
public final int getInputIndex()
public final int getInputLength()

Class: AmpersandToken   previous next package

Represents & ampersand character used to indicate Mapper AND operation in certain contexts and as literal text in other cases.
Treat as "thread-safe", since immutable once created.
public class com.arsi.mj.maprpt.lexer.tokens.cmd.AmpersandToken
  extends com.arsi.mj.maprpt.lexer.tokens.cmd.CommandTokenBase
Constructors
public AmpersandToken(com.arsi.mj.maprpt.parser.line.types.AtLine aLine, int aTokenIndex)

Class: AsteriskToken   previous next package

Represents * asterisk character used to indicate Mapper global variables and mathematical operations in certain contexts and as literal text in other cases.
Treat as "thread-safe", since immutable once created.
public class com.arsi.mj.maprpt.lexer.tokens.cmd.AsteriskToken
  extends com.arsi.mj.maprpt.lexer.tokens.cmd.CommandTokenBase
Constructors
public AsteriskToken(com.arsi.mj.maprpt.parser.line.types.AtLine aLine, int aTokenIndex)

Class: BlankToken   previous next package

Represents blank (i.e., space) character used to separate Mapper arguments and commands, or as literal text.
Treat as "thread-safe", since immutable once created.
public class com.arsi.mj.maprpt.lexer.tokens.cmd.BlankToken
  extends com.arsi.mj.maprpt.lexer.tokens.cmd.CommandTokenBase
Constructors
public BlankToken(com.arsi.mj.maprpt.parser.line.types.AtLine aLine, int aTokenIndex, java.lang.String aBlankString)

Class: ColonToken   previous next package

Represents : colon character used to delimit Mapper labels and as literal text in other cases.
Treat as "thread-safe", since immutable once created.
public class com.arsi.mj.maprpt.lexer.tokens.cmd.ColonToken
  extends com.arsi.mj.maprpt.lexer.tokens.cmd.CommandTokenBase
Constructors
public ColonToken(com.arsi.mj.maprpt.parser.line.types.AtLine aLine, int aTokenIndex)

Class: CommandTokenBase   previous next package

Base class that provides for common attributes of command tokens, all "true" concrete content token implementations derive from this class.
Treat this class as essentially "thread-safe", since it's state is intended to be immutable once created.
public abstract class com.arsi.mj.maprpt.lexer.tokens.cmd.CommandTokenBase
  extends java.lang.Object
  implements com.arsi.mj.maprpt.lexer.tokens.ICommandToken
Constructors
protected CommandTokenBase(com.arsi.mj.maprpt.parser.line.types.AtLine aLine, int aTokenIndex, java.lang.String aTokenValue)
Methods
public final com.arsi.mj.maprpt.parser.line.types.AtLine getHostLine()
public final int getTokenIndex()
public final java.lang.String getTokenValue()

Class: CommaToken   previous next package

Represents , comma character used to separate Mapper arguments in most lexical contexts, and as literal text in other cases.
Treat as "thread-safe", since immutable once created.
public class com.arsi.mj.maprpt.lexer.tokens.cmd.CommaToken
  extends com.arsi.mj.maprpt.lexer.tokens.cmd.CommandTokenBase
Constructors
public CommaToken(com.arsi.mj.maprpt.parser.line.types.AtLine aLine, int aTokenIndex)

Class: DollarToken   previous next package

Represents $ dollar sign character used to indicate Mapper environment variables and reserved words in certain contexts, and as literal text in other cases.
Treat as "thread-safe", since immutable once created.
public class com.arsi.mj.maprpt.lexer.tokens.cmd.DollarToken
  extends com.arsi.mj.maprpt.lexer.tokens.cmd.CommandTokenBase
Constructors
public DollarToken(com.arsi.mj.maprpt.parser.line.types.AtLine aLine, int aTokenIndex)

Class: EqualToken   previous next package

Represents = equal-sign character used to indicate Mapper variable initialization or comparison.
Treat as "thread-safe", since immutable once created.
public class com.arsi.mj.maprpt.lexer.tokens.cmd.EqualToken
  extends com.arsi.mj.maprpt.lexer.tokens.cmd.CommandTokenBase
Constructors
public EqualToken(com.arsi.mj.maprpt.parser.line.types.AtLine aLine, int aTokenIndex)

Class: FloatDigitsToken   previous next package

Represents a set of digits suitable as a floating point literal. This includes one or more decimal digits and one decimal point, but not a sign nor any scientific notation.
Treat as "thread-safe", since immutable once created.
public class com.arsi.mj.maprpt.lexer.tokens.cmd.FloatDigitsToken
  extends com.arsi.mj.maprpt.lexer.tokens.cmd.CommandTokenBase
Constructors
public FloatDigitsToken(com.arsi.mj.maprpt.parser.line.types.AtLine aLine, int aTokenIndex, java.lang.String aDigitString)

Class: GreaterThanToken   previous next package

Represents > greater-than character used to indicate Mapper named variable or comparison.
Treat as "thread-safe", since immutable once created.
public class com.arsi.mj.maprpt.lexer.tokens.cmd.GreaterThanToken
  extends com.arsi.mj.maprpt.lexer.tokens.cmd.CommandTokenBase
Constructors
public GreaterThanToken(com.arsi.mj.maprpt.parser.line.types.AtLine aLine, int aTokenIndex)

Class: HyphenToken   previous next package

Represents - hyphen character used to indicate a negative number or subtraction in certain lexical contexts, and as literal text in other cases.
Treat as "thread-safe", since immutable once created.
public class com.arsi.mj.maprpt.lexer.tokens.cmd.HyphenToken
  extends com.arsi.mj.maprpt.lexer.tokens.cmd.CommandTokenBase
Constructors
public HyphenToken(com.arsi.mj.maprpt.parser.line.types.AtLine aLine, int aTokenIndex)

Class: IntegerDigitsToken   previous next package

Represents a set of digits suitable as an integer literal. This includes one or more decimal digits, but no decimal point, sign nor any scientific notation.
Treat as "thread-safe", since immutable once created.
public class com.arsi.mj.maprpt.lexer.tokens.cmd.IntegerDigitsToken
  extends com.arsi.mj.maprpt.lexer.tokens.cmd.CommandTokenBase
Constructors
public IntegerDigitsToken(com.arsi.mj.maprpt.parser.line.types.AtLine aLine, int aTokenIndex, java.lang.String aDigitString)

Class: LeftBracketToken   previous next package

Represents [ left bracket character used to indicate Mapper array elements in certain contexts and as literal text in other cases.
Treat as "thread-safe", since immutable once created.
public class com.arsi.mj.maprpt.lexer.tokens.cmd.LeftBracketToken
  extends com.arsi.mj.maprpt.lexer.tokens.cmd.CommandTokenBase
Constructors
public LeftBracketToken(com.arsi.mj.maprpt.parser.line.types.AtLine aLine, int aTokenIndex)

Class: LeftParenthesisToken   previous next package

Represents ( left parenthesis character used to indicate Mapper substring range or operator precedences in certain contexts, and as literal text in other cases.
Treat as "thread-safe", since immutable once created.
public class com.arsi.mj.maprpt.lexer.tokens.cmd.LeftParenthesisToken
  extends com.arsi.mj.maprpt.lexer.tokens.cmd.CommandTokenBase
Constructors
public LeftParenthesisToken(com.arsi.mj.maprpt.parser.line.types.AtLine aLine, int aTokenIndex)

Class: LessThanToken   previous next package

Represents < less-than character used to indicate Mapper named variable or comparison.
Treat as "thread-safe", since immutable once created.
public class com.arsi.mj.maprpt.lexer.tokens.cmd.LessThanToken
  extends com.arsi.mj.maprpt.lexer.tokens.cmd.CommandTokenBase
Constructors
public LessThanToken(com.arsi.mj.maprpt.parser.line.types.AtLine aLine, int aTokenIndex)

Class: OtherToken   previous next package

Catch-all command token that represents an "other" character that has no special contextual meaning to the command token lexer (but may have meaning to a parser built on top of the lexer).
Treat as "thread-safe", since immutable once created.
public class com.arsi.mj.maprpt.lexer.tokens.cmd.OtherToken
  extends com.arsi.mj.maprpt.lexer.tokens.cmd.CommandTokenBase
Constructors
public OtherToken(com.arsi.mj.maprpt.parser.line.types.AtLine aLine, int aTokenIndex, char aChar)

Class: PeriodToken   previous next package

Represents the period that terminates all commands in an at-sign line, and includes an optional comment that follows the period (e.g., "@. this is a comment").
public class com.arsi.mj.maprpt.lexer.tokens.cmd.PeriodToken
  extends com.arsi.mj.maprpt.lexer.tokens.cmd.CommandTokenBase
Constructors
public PeriodToken(com.arsi.mj.maprpt.parser.line.types.AtLine aLine)
public PeriodToken(com.arsi.mj.maprpt.parser.line.types.AtLine aLine, int aTokenIndex, java.lang.String aComment)
Methods
public final java.lang.String getComment()

Class: PlusToken   previous next package

Represents + plus character used to indicate a positive number or addition in certain lexical contexts, and as literal text in other cases.
Treat as "thread-safe", since immutable once created.
public class com.arsi.mj.maprpt.lexer.tokens.cmd.PlusToken
  extends com.arsi.mj.maprpt.lexer.tokens.cmd.CommandTokenBase
Constructors
public PlusToken(com.arsi.mj.maprpt.parser.line.types.AtLine aLine, int aTokenIndex)

Class: QuotedStringToken   previous next package

Represents a string of characters enclosed in single quotes (or apostrophes to use Mapper terminology). The quotes are not included in the token value.
Treat as "thread-safe", since immutable once created.
public class com.arsi.mj.maprpt.lexer.tokens.cmd.QuotedStringToken
  extends com.arsi.mj.maprpt.lexer.tokens.cmd.CommandTokenBase
Constructors
public QuotedStringToken(com.arsi.mj.maprpt.parser.line.types.AtLine aLine, int aTokenIndex, java.lang.String aString)

Class: RightBracketToken   previous next package

Represents ] right bracket character used to indicate Mapper array elements in certain contexts and as literal text in other cases.
Treat as "thread-safe", since immutable once created.
public class com.arsi.mj.maprpt.lexer.tokens.cmd.RightBracketToken
  extends com.arsi.mj.maprpt.lexer.tokens.cmd.CommandTokenBase
Constructors
public RightBracketToken(com.arsi.mj.maprpt.parser.line.types.AtLine aLine, int aTokenIndex)

Class: RightParenthesisToken   previous next package

Represents ) right parenthesis character used to indicate Mapper substring range or operator precedences in certain contexts, and as literal text in other cases.
Treat as "thread-safe", since immutable once created.
public class com.arsi.mj.maprpt.lexer.tokens.cmd.RightParenthesisToken
  extends com.arsi.mj.maprpt.lexer.tokens.cmd.CommandTokenBase
Constructors
public RightParenthesisToken(com.arsi.mj.maprpt.parser.line.types.AtLine aLine, int aTokenIndex)

Class: ScientificDigitsToken   previous next package

Represents a set of digits suitable as a scientific notation literal. This includes one or more decimal digits, one decimal point and 'E' or 'e', but not a sign for the mantissa.
Treat as "thread-safe", since immutable once created.
public class com.arsi.mj.maprpt.lexer.tokens.cmd.ScientificDigitsToken
  extends com.arsi.mj.maprpt.lexer.tokens.cmd.CommandTokenBase
Constructors
public ScientificDigitsToken(com.arsi.mj.maprpt.parser.line.types.AtLine aLine, int aTokenIndex, java.lang.String aDigitString)

Class: SemicolonToken   previous next package

Represents ; semicolon character used to separate Mapper expressions in certain lexical contexts, and as literal text in other cases.
When MaprptLexer is used to parse SC command directives (e.g., FLD, DATA), the semicolon should be treated by the caller as a directive terminator. Use useCommandTokenAsEndOfLine to return this token instead of PeriodToken when the end of a line containing directives is reached.
Treat as "thread-safe", since immutable once created.
public class com.arsi.mj.maprpt.lexer.tokens.cmd.SemicolonToken
  extends com.arsi.mj.maprpt.lexer.tokens.cmd.CommandTokenBase
Constructors
public SemicolonToken(com.arsi.mj.maprpt.parser.line.types.AtLine aLine)
public SemicolonToken(com.arsi.mj.maprpt.parser.line.types.AtLine aLine, int aTokenIndex)

Class: SlashToken   previous package

Represents / forward slash character used to separate parameters or division in certain lexical contexts, and as literal text in other cases.
Treat as "thread-safe", since immutable once created.
public class com.arsi.mj.maprpt.lexer.tokens.cmd.SlashToken
  extends com.arsi.mj.maprpt.lexer.tokens.cmd.CommandTokenBase
Constructors
public SlashToken(com.arsi.mj.maprpt.parser.line.types.AtLine aLine, int aTokenIndex)