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

 

Package: com.arsi.mj.maprpt.lexer.ptree.cmd.sc.directive.emp  previous next contents

Package com.arsi.mj.maprpt.lexer.ptree.cmd.sc.directive.emp contains the following classes and interfaces.
Classes and Interfaces
EmpDirectiveNode Parse node that represents a EMP SC directive.
EmpDirectiveParser Parses an EMP SC directive.
EmpDirectiveState Manages the processing state for EMP options.

Class: EmpDirectiveNode   next package

Parse node that represents a EMP SC directive.
Treat this class as "thread-hostile" since it holds substantial state without method synchronization; instances should only be used by single thread at a time.

public class com.arsi.mj.maprpt.lexer.ptree.cmd.sc.directive.emp.EmpDirectiveNode
  extends com.arsi.mj.maprpt.lexer.ptree.cmd.sc.directive.ScDirectiveNode
Inner Class Option
Enumerated options for EMP directive, associated with option letter or character. This class must implement that static method fromLetter for use with class CmdOptionConcatExpr.
public static final class com.arsi.mj.maprpt.lexer.ptree.cmd.sc.directive.emp.EmpDirectiveNode.Option
  extends java.lang.Enum
Indicates column separators should be added to the text.
public static final com.arsi.mj.maprpt.lexer.ptree.cmd.sc.directive.emp.EmpDirectiveNode.Option COLUMN_SEPARATOR
Indicates column separators should be added to the text.
public static final com.arsi.mj.maprpt.lexer.ptree.cmd.sc.directive.emp.EmpDirectiveNode.Option COLUMN_SEPARATOR2
Indicates the text should be struck through.
public static final com.arsi.mj.maprpt.lexer.ptree.cmd.sc.directive.emp.EmpDirectiveNode.Option STRIKETHRU
Indicates the text should be underscored.
public static final com.arsi.mj.maprpt.lexer.ptree.cmd.sc.directive.emp.EmpDirectiveNode.Option UNDERSCORE
Indicates the text should be underscored.
public static final com.arsi.mj.maprpt.lexer.ptree.cmd.sc.directive.emp.EmpDirectiveNode.Option UNDERSCORE2
Looks up an instance by the match for the internal representation.
Parameters:
aChar - the character to match
Returns:
the matched option, or null if there is no match
public static com.arsi.mj.maprpt.lexer.ptree.cmd.sc.directive.emp.EmpDirectiveNode.Option fromLetter(char aChar)
Retrieves the internal representation.
Returns:
the corresponding character data
public char getLetter()
public static com.arsi.mj.maprpt.lexer.ptree.cmd.sc.directive.emp.EmpDirectiveNode.Option valueOf(java.lang.String name)
public static com.arsi.mj.maprpt.lexer.ptree.cmd.sc.directive.emp.EmpDirectiveNode.Option values()
Constructors
Initializes an instance of this class.
Parameters:
aHostLine - Mapper report line that hosts this command
someOptionExprs - the options provided to the command
public EmpDirectiveNode(com.arsi.mj.maprpt.parser.line.types.AtLine aHostLine, java.util.List someOptionExprs)
Methods
Get options applicable to directive.
Returns:
options applicable to directive (empty set if none, meaning emphasis is to be removed).
public final java.util.EnumSet getOptions()

Class: EmpDirectiveParser   previous next package

Parses an EMP SC directive.
Treat this class as "thread-hostile"; instances should be created, used and discarded by single thread at a time.

public class com.arsi.mj.maprpt.lexer.ptree.cmd.sc.directive.emp.EmpDirectiveParser
  extends com.arsi.mj.maprpt.lexer.ptree.cmd.sc.directive.ScDirectiveParserBase
  implements com.arsi.mj.maprpt.lexer.ptree.cmd.sc.directive.IScDirectiveParser
Constructors
public EmpDirectiveParser()
Methods
public com.arsi.mj.maprpt.lexer.ptree.cmd.sc.directive.ScDirectiveParseResult parseDirective(com.arsi.mj.maprpt.lexer.tokens.IMaprptToken anInitialToken, com.arsi.mj.maprpt.lexer.ptree.cmd.sc.directive.ScDirectiveLexer aLexer, org.springframework.context.ApplicationContext anAppCtx)
    throws com.arsi.mj.MJTranslateException

Class: EmpDirectiveState   previous package

Manages the processing state for EMP options.
public class com.arsi.mj.maprpt.lexer.ptree.cmd.sc.directive.emp.EmpDirectiveState
  extends java.lang.Object
Inner Class EmpProcessingState
The potential states.
public static final class com.arsi.mj.maprpt.lexer.ptree.cmd.sc.directive.emp.EmpDirectiveState.EmpProcessingState
  extends java.lang.Enum
Indicates that processing considers all content to be comments.
public static final com.arsi.mj.maprpt.lexer.ptree.cmd.sc.directive.emp.EmpDirectiveState.EmpProcessingState COMMENT
Indicates that processing is done.
public static final com.arsi.mj.maprpt.lexer.ptree.cmd.sc.directive.emp.EmpDirectiveState.EmpProcessingState DONE
Indicates that a parsing error has occurred.
public static final com.arsi.mj.maprpt.lexer.ptree.cmd.sc.directive.emp.EmpDirectiveState.EmpProcessingState ERROR
Indicates that we are looking for the next option.
public static final com.arsi.mj.maprpt.lexer.ptree.cmd.sc.directive.emp.EmpDirectiveState.EmpProcessingState NEXT_OPTION
Indicates that an option was processed.
public static final com.arsi.mj.maprpt.lexer.ptree.cmd.sc.directive.emp.EmpDirectiveState.EmpProcessingState OPTION
public static com.arsi.mj.maprpt.lexer.ptree.cmd.sc.directive.emp.EmpDirectiveState.EmpProcessingState valueOf(java.lang.String name)
public static com.arsi.mj.maprpt.lexer.ptree.cmd.sc.directive.emp.EmpDirectiveState.EmpProcessingState values()
Constructors
public EmpDirectiveState()
Methods
Obtains the option values accumulated during processing.
Returns:
the parsed options
public java.util.List getProcessedOptions()
Obtains the most recent state.
Returns:
the current state
public com.arsi.mj.maprpt.lexer.ptree.cmd.sc.directive.emp.EmpDirectiveState.EmpProcessingState getState()
Adjusts the current processing state based on the provided token. If the token corresponds to an option, it will be parsed and aggregated.
Parameters:
aToken - the next token to process
public void processToken(com.arsi.mj.maprpt.lexer.tokens.ICommandToken aToken)