Package: com.arsi.mj.maprpt.lexer.ptree.cmd.litcbk
previous next contents
Package com.arsi.mj.maprpt.lexer.ptree.cmd.litcbk contains the following classes and interfaces.
| Classes and Interfaces |
| DrawerLetterCallback |
Literal callback the validates and captures a drawer letter. |
| ILiteralCallback |
Defines method to capture and check validity of literal text during command parsing. |
| JumpExprCallback |
Literal callback the validates and captures literals that may occur in
a jump expression, i.e., an expression that may be used as the target
of a GTO or computed IF statement. |
| LiteralCallbackBase |
Abstract base class for literal call backs that contains common state and behavior. |
| PositiveIntegerCallback |
Literal callback the validates and captures a positive decimal integer. |
| ResultNumberCallback |
Literal callback the validates and captures a result number such as
-0 and -2. |
| ResultOrPositiveCallback |
Literal callback the validates and captures a positive integer or result
number as -0 and -2. |
| StringCallback |
Literal callback the validates and captures a string. |
| YesNoCallback |
Literal callback the validates and captures a 'Y'es/'N'o string. |
| YesNoQuickCallback |
Literal callback the validates and captures a 'Y'es/'N'o string, and supports
'Q'uick as an alias for 'Y'es (used by the @DSP command). |
Class: DrawerLetterCallback
next
package
Literal callback the validates and captures a drawer letter.
Treat this class as "thread-hostile" as it is intended to be created, used and
discarded by a single thread.
| Constructors |
Initializes an instance of this callback.
public DrawerLetterCallback(java.lang.String aDesc)
|
Defines method to capture and check validity of literal text during command parsing.
public interface com.arsi.mj.maprpt.lexer.ptree.cmd.litcbk.ILiteralCallback
| Methods |
Get canonical value of captured literal.
- Returns:
- canonical value of captured literal (e.g.,
Integer).
public java.lang.Object canonicalValue()
|
Determines if literal is valid in a certain context, e.g., if an integer cabinet
number is expected, validate that literal is a valid integer, and to capture the
literal as an object.
- Parameters:
aLiteral - literal text parsed from an expression to be checked for validity.- Returns:
- NULL if literal is valid in a given context, otherwise brief message that
describes why literal is invalid.
public java.lang.String validateAndCapture(java.lang.String aLiteral)
|
Literal callback the validates and captures literals that may occur in
a jump expression, i.e., an expression that may be used as the target
of a
GTO or computed
IF statement.
Treat this class as "thread-hostile" as it is intended to be created, used and
discarded by a single thread.
| Fields |
Constant that represents the END label.
public static final int END_LABEL = 2147483647
|
| Constructors |
Initializes an instance of this callback.
public JumpExprCallback(java.lang.String aDesc)
|
| Methods |
Returns the captured label number, LIN offset or RPX
report number, if any, as an Integer.
- See Also:
- com.arsi.mj.maprpt.lexer.ptree.cmd.litcbk.ILiteralCallback#canonicalValue()
public java.lang.Object canonicalValue()
|
Indicates that parsed integer literal is a label number (e.g., 0100) or
END keyword was recognized.
- Returns:
- true parsed integer literal is a label number or
END_LABEL,
false if LIN offset or RPX report number, or NULL if no integer literal was parsed.
public java.lang.Boolean isLabelNumber()
|
Indicates that parsed integer literal is a LIN offset (e.g., LIN -5).
- Returns:
- true parsed integer literal is a LIN offset, false if label number or RPX report
number, or NULL if no integer literal was parsed.
public java.lang.Boolean isLineOffset()
|
Indicates that parsed integer literal is an RPX report number (e.g., RPX 35).
- Returns:
- true parsed integer literal is an RPX report number, false if label number or LIN offset,
or NULL if no integer literal was parsed.
public java.lang.Boolean isReportNumber()
|
public java.lang.String validateAndCapture(java.lang.String aLiteral)
|
Abstract base class for literal call backs that contains common state and behavior.
public class com.arsi.mj.maprpt.lexer.ptree.cmd.litcbk.LiteralCallbackBase
extends java.lang.Object
| Fields |
Description of argument, parameter, field, etc. where literal value occurs.
protected final java.lang.String descOfLiteral
|
| Constructors |
Initializes an instance of this class.
- Parameters:
aDesc - description of argument, parameter, field, etc. where literal value
occurs (e.g., "starting line number").
protected LiteralCallbackBase(java.lang.String aDesc)
|
Literal callback the validates and captures a positive decimal integer.
Treat this class as "thread-hostile" as it is intended to be created, used and
discarded by a single thread.
| Constructors |
Initializes an instance of this callback.
public PositiveIntegerCallback(java.lang.String aDesc)
|
Literal callback the validates and captures a result number such as
-0 and
-2.
Treat this class as "thread-hostile" as it is intended to be created, used and
discarded by a single thread.
| Constructors |
Initializes an instance of this callback.
public ResultNumberCallback(java.lang.String aDesc)
|
Literal callback the validates and captures a positive integer or result
number as
-0 and
-2.
Treat this class as "thread-hostile" as it is intended to be created, used and
discarded by a single thread.
| Constructors |
Initializes an instance of this callback.
public ResultOrPositiveCallback(java.lang.String aDesc)
|
| Methods |
Returns the captured result (zero or negative) or positive Integer , if any.
- See Also:
- com.arsi.mj.maprpt.lexer.ptree.cmd.litcbk.ILiteralCallback#canonicalValue()
public java.lang.Object canonicalValue()
|
Indicates that parsed integer literal is a result number (e.g., -0,
-2).
- Returns:
- true if result number, false if positive integer, or NULL if no integer
literal was parsed.
public java.lang.Boolean isResultNumber()
|
public java.lang.String validateAndCapture(java.lang.String aLiteral)
|
Literal callback the validates and captures a string.
Treat this class as "thread-hostile" as it is intended to be created, used and
discarded by a single thread.
| Constructors |
Initializes an instance of this callback.
public StringCallback(java.lang.String aDesc)
|
Literal callback the validates and captures a 'Y'es/'N'o string.
Treat this class as "thread-hostile" as it is intended to be created, used and
discarded by a single thread.
| Constructors |
Initializes an instance of this callback.
public YesNoCallback(java.lang.String aDesc)
|
Literal callback the validates and captures a 'Y'es/'N'o string, and supports
'Q'uick as an alias for 'Y'es (used by the
@DSP command).
Treat this class as "thread-hostile" as it is intended to be created, used and
discarded by a single thread.
| Constructors |
Initializes an instance of this callback.
public YesNoQuickCallback(java.lang.String aDesc)
|