chemaxon.checkers

Class StructureCheck

java.lang.Object

chemaxon.checkers.StructureCheck

@PublicAPI
public final class StructureCheck
extends java.lang.Object

This class contains the command line interface for running inner StructureChecker and StructureFixer instances.

Since:

Marvin 5.4

Version:

5.12

Author:

Attila Szabo, Imre Barna

Constructor Summary

Constructors

Constructor and Description
StructureCheck() Creates a new structures checker console, sets the logging on null stream.

Method Summary

Modifier and Type	Method and 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 error
boolean	isErrorOccured() Deprecated. Misspelled method name, use isErrorOccurred() instead.
boolean	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(java.lang.String[] args) Standard JAVA Main function which delegates the run mechanism to the run(String[]) method.
void	run(java.lang.String[] args) This method runs the command line parameterized by the args array of String

Methods inherited from class java.lang.Object

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

Constructor Detail

StructureCheck

public StructureCheck()

Creates a new structures checker console, sets the logging on null stream.

Method Detail

main

public static void main(java.lang.String[] args)

Standard JAVA Main function which delegates the run mechanism to the run(String[]) method.

Parameters:

args - the argument list of main function

run

public void run(java.lang.String[] args)

This method runs the command line parameterized by the args array of String

Parameters:

args - this array of String 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

isErrorOccured

@Deprecated
 @SubjectToRemoval(date=JUL_01_2021)
public boolean isErrorOccured()

Deprecated. Misspelled method name, use isErrorOccurred() instead.

Returns whether structure error found in the input files.

Returns:

true if structure error found, false otherwise.

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.