Package chemaxon.checkers
Class StructureCheck
- java.lang.Object
-
- chemaxon.checkers.StructureCheck
-
@PublicAPI public final class StructureCheck extends Object
This class contains the command line interface for running innerStructureChecker
andStructureFixer
instances.- Since:
- Marvin 5.4
-
-
Constructor Summary
Constructors Constructor Description StructureCheck()
Creates a new structures checker console, sets the logging on null stream.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description chemaxon.checkers.logger.TemplateBasedLogger
getReporter()
Gets the reporter used by the check procedure.protected boolean
isCheckerActionHelpPrinting()
Returns whether the checker action help text needs to be printed.protected boolean
isDone()
This function returns true when command line process finished without any errorboolean
isErrorOccurred()
Returns whether structure error found in the input files.protected boolean
isFixerActionHelpPrinting()
Returns whether the fixer action help text needs to be printed.protected boolean
isFixing()
Returns whether structure checker needs to fix invalid structures automatically.protected boolean
isHelpPrinting()
Returns whether the help text needs to be printed.protected boolean
isLogging()
Returns whether there is a log file available for logging.protected boolean
isReporting()
Returns whether help text is printed.static void
main(String[] args)
Standard JAVA Main function which delegates the run mechanism to therun(String[])
method.void
run(String[] args)
This method runs the command line parameterized by the args array ofString
-
-
-
Method Detail
-
main
public static void main(String[] args)
Standard JAVA Main function which delegates the run mechanism to therun(String[])
method.- Parameters:
args
- the argument list of main function
-
run
public void run(String[] args)
This method runs the command line parameterized by the args array ofString
- Parameters:
args
- this array ofString
contains the arguments of the command line tool
-
isFixing
protected boolean isFixing()
Returns whether structure checker needs to fix invalid structures automatically.- Returns:
- true is automatic fix is needed, false otherwise.
-
isHelpPrinting
protected boolean isHelpPrinting()
Returns whether the help text needs to be printed.- Returns:
- true when help text needs to be printed, false otherwise
-
isCheckerActionHelpPrinting
protected boolean isCheckerActionHelpPrinting()
Returns whether the checker action help text needs to be printed.- Returns:
- true when checker action help text needs to be printed, false otherwise
-
isFixerActionHelpPrinting
protected boolean isFixerActionHelpPrinting()
Returns whether the fixer action help text needs to be printed.- Returns:
- true when fixer action help text needs to be printed, false otherwise
-
isReporting
protected boolean isReporting()
Returns whether help text is printed.- Returns:
- true if help text is printed, false otherwise.
-
isDone
protected boolean isDone()
This function returns true when command line process finished without any error- Returns:
- true when command line process finished without any error, false otherwise.
-
isLogging
protected boolean isLogging()
Returns whether there is a log file available for logging.- Returns:
- true if logging results into a file
-
isErrorOccurred
public boolean isErrorOccurred()
Returns whether structure error found in the input files.- Returns:
- true if structure error found, false otherwise.
-
getReporter
public chemaxon.checkers.logger.TemplateBasedLogger getReporter()
Gets the reporter used by the check procedure.- Returns:
- the reporter used by the check procedure.
-
-