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.opts  previous next contents

Package com.arsi.mj.maprpt.lexer.ptree.cmd.sc.directive.opts contains the following classes and interfaces.
Classes and Interfaces
OptsDirectiveNode Parse node that represents a MODE SC directive.
OptsDirectiveParser Parses a OPTS SC directive.
OptsExpansion Extracts OPTS option content from the provided input.

Class: OptsDirectiveNode   next package

Parse node that represents a MODE 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.opts.OptsDirectiveNode
  extends com.arsi.mj.maprpt.lexer.ptree.cmd.sc.directive.ScDirectiveNode
Constructors
Initializes an instance of this class.
Parameters:
aHostLine - Mapper report line that hosts this command
aUsageMode - the mode in which the options should be applied
someOptionExprs - the options provided to the command
public OptsDirectiveNode(com.arsi.mj.maprpt.parser.line.types.AtLine aHostLine, com.arsi.mj.maprpt.lexer.ptree.expr.ConcatExpr someOptionExprs)
Methods
public com.arsi.mj.maprpt.lexer.ptree.expr.ConcatExpr getOptionExpr()

Class: OptsDirectiveParser   previous next package

Parses a OPTS 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.opts.OptsDirectiveParser
  extends com.arsi.mj.maprpt.lexer.ptree.cmd.sc.directive.ScDirectiveParserBase
  implements com.arsi.mj.maprpt.lexer.ptree.cmd.sc.directive.IScDirectiveParser
Constructors
public OptsDirectiveParser()
Methods
Required implementation.
See Also:
com.arsi.mj.maprpt.lexer.ptree.cmd.sc.directive.IScDirectiveParser#parseDirective(com.arsi.mj.maprpt.lexer.tokens.IMaprptToken, com.arsi.mj.maprpt.lexer.ptree.cmd.sc.directive.ScDirectiveLexer, org.springframework.context.ApplicationContext)
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: OptsExpansion   previous package

Extracts OPTS option content from the provided input. Feedback from the parsing results is also available. Treat this class as "thread-safe"; once created, an instance can be treated as immutable.

public class com.arsi.mj.maprpt.lexer.ptree.cmd.sc.directive.opts.OptsExpansion
  extends java.lang.Object
Inner Class OptionUsage
Determines how the provided options should be used.
public static final class com.arsi.mj.maprpt.lexer.ptree.cmd.sc.directive.opts.OptsExpansion.OptionUsage
  extends java.lang.Enum
Provided options should be added to the current SC options.
public static final com.arsi.mj.maprpt.lexer.ptree.cmd.sc.directive.opts.OptsExpansion.OptionUsage ADD
Provided options should be removed from the current SC options.
public static final com.arsi.mj.maprpt.lexer.ptree.cmd.sc.directive.opts.OptsExpansion.OptionUsage REMOVE
Provided options should be used in place of the current SC options.
public static final com.arsi.mj.maprpt.lexer.ptree.cmd.sc.directive.opts.OptsExpansion.OptionUsage REPLACE
public static com.arsi.mj.maprpt.lexer.ptree.cmd.sc.directive.opts.OptsExpansion.OptionUsage valueOf(java.lang.String name)
public static com.arsi.mj.maprpt.lexer.ptree.cmd.sc.directive.opts.OptsExpansion.OptionUsage values()
Constructors
Initializes an instance of this class.
Parameters:
aTextExpression - the input expression to expand
public OptsExpansion(java.lang.String aTextExpression)
Methods
Any options successfully parsed.
Returns:
the extracted options
public java.util.Set getParsedOptions()
Obtains the derived option usage information
Returns:
the usage mode from the text, or null if none was provided
public com.arsi.mj.maprpt.lexer.ptree.cmd.sc.directive.opts.OptsExpansion.OptionUsage getUsageMode()
Indicates if the parsed content should be used.
Returns:
true if the content is usable; false otherwise
public boolean isValid()