gov.nih.nlm.nls.stmt.CmdLine

Class OptionApi

java.lang.Object

gov.nih.nlm.nls.stmt.CmdLine.OptionApi

public class OptionApi
extends java.lang.Object

This is a class for all static method used in cmdLine option.

History:

Notes:

Version:

V-2015

Author:

NLM NLS Development Team

Method Summary

Methods

Modifier and Type	Method and Description
static boolean	CheckArguments(java.lang.String in, java.lang.String system)
static boolean	CheckOption(gov.nih.nlm.nls.lvg.CmdLineSyntax.OptionItem inItem, gov.nih.nlm.nls.lvg.CmdLineSyntax.OptionItem systemItem)
static boolean	CheckOption(gov.nih.nlm.nls.lvg.CmdLineSyntax.OptionItem inItem, java.lang.String systemItemStr)
static boolean	CheckOptionItem(gov.nih.nlm.nls.lvg.CmdLineSyntax.OptionItem inputItem, gov.nih.nlm.nls.lvg.CmdLineSyntax.Option systemOption, boolean PrintRun, boolean PrintError)
static boolean	CheckSyntax(gov.nih.nlm.nls.lvg.CmdLineSyntax.Option option, gov.nih.nlm.nls.lvg.CmdLineSyntax.Option systemOption, boolean printRun, boolean printError) Check if the input option is legal according to the given system option This method can be used as syntax error checker
static java.lang.String	CombineArguments(java.lang.String oldStr, java.lang.String systemStr)
static java.lang.String	GetLegalSyntax(gov.nih.nlm.nls.lvg.CmdLineSyntax.OptionItem item, gov.nih.nlm.nls.lvg.CmdLineSyntax.Option systemOption)
static boolean	IsLegalArgument(java.lang.String in, java.lang.String system)
static boolean	IsLegalArguments(java.lang.String in, java.lang.String system)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

CheckSyntax

public static boolean CheckSyntax(gov.nih.nlm.nls.lvg.CmdLineSyntax.Option option,
                  gov.nih.nlm.nls.lvg.CmdLineSyntax.Option systemOption,
                  boolean printRun,
                  boolean printError)

Check if the input option is legal according to the given system option This method can be used as syntax error checker

Parameters:

option - input option to be checked

systemOption - system option that the checking is based on

printRun - a boolean flag to print algorithm details

printError - a boolean flag to print error

Returns:

legal option or not

CheckOption

public static boolean CheckOption(gov.nih.nlm.nls.lvg.CmdLineSyntax.OptionItem inItem,
                  java.lang.String systemItemStr)

CheckOptionItem

public static boolean CheckOptionItem(gov.nih.nlm.nls.lvg.CmdLineSyntax.OptionItem inputItem,
                      gov.nih.nlm.nls.lvg.CmdLineSyntax.Option systemOption,
                      boolean PrintRun,
                      boolean PrintError)

GetLegalSyntax

public static java.lang.String GetLegalSyntax(gov.nih.nlm.nls.lvg.CmdLineSyntax.OptionItem item,
                              gov.nih.nlm.nls.lvg.CmdLineSyntax.Option systemOption)

CombineArguments

public static java.lang.String CombineArguments(java.lang.String oldStr,
                                java.lang.String systemStr)

CheckOption

public static boolean CheckOption(gov.nih.nlm.nls.lvg.CmdLineSyntax.OptionItem inItem,
                  gov.nih.nlm.nls.lvg.CmdLineSyntax.OptionItem systemItem)

CheckArguments

public static boolean CheckArguments(java.lang.String in,
                     java.lang.String system)

IsLegalArguments

public static boolean IsLegalArguments(java.lang.String in,
                       java.lang.String system)

IsLegalArgument

public static boolean IsLegalArgument(java.lang.String in,
                      java.lang.String system)