Package chemaxon.checkers.result

Class ExplicitHydrogenResult

java.lang.Object

chemaxon.checkers.result.DefaultStructureCheckerResult

chemaxon.checkers.result.ExplicitHydrogenResult

All Implemented Interfaces:

StructureCheckerResult

@PublicAPI
public class ExplicitHydrogenResult
extends DefaultStructureCheckerResult

A descendant of DefaultStructureCheckerResult for identifying explicit hydrogen problems, thus errorType property is StructureCheckerErrorType.EXPLICIT_H by default.

Since:

Marvin 5.3

Constructor Summary

Constructors

Constructor	Description
ExplicitHydrogenResult(StructureChecker source, List<MolAtom> atoms, List<MolBond> bonds, Molecule molecule, String description, int implicitizeFlag, String name, String localMenuName, String helpText, Icon icon)	Constructor which initialize all the properties.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
int	getImplicitizeFlag()	Returns the flag which can used to identify which hydrogens should be implicitize.
int	hashCode()

Methods inherited from class chemaxon.checkers.result.DefaultStructureCheckerResult

convert, getAtoms, getBonds, getDescription, getErrorCount, getErrorDescription, getErrorType, getHelpText, getIcon, getLocalMenuName, getMolecule, getName, getSource, setAtoms, setBonds, setMolecule, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ExplicitHydrogenResult

public ExplicitHydrogenResult(StructureChecker source,
                              List<MolAtom> atoms,
                              List<MolBond> bonds,
                              Molecule molecule,
                              String description,
                              int implicitizeFlag,
                              String name,
                              String localMenuName,
                              String helpText,
                              Icon icon)

Constructor which initialize all the properties. errorType property is StructureCheckerErrorType.EXPLICIT_H by default.

Parameters:

source - is the StructureChecker instance which identified the problem

atoms - a List of MolAtom which contains the affected atoms of the problem

bonds - a List of MolBond which contains the affected bonds of the problem

molecule - is a Molecule instance which contains the described problem

description - is short information about the problem

implicitizeFlag - is the used by the checker to identify which hydrogens should be implicitized

name - is the name of the checker which found the described problem

localMenuName - is a String which should be shown in the local menu of Marvin Sketch

helpText - is help message for the problem

icon - is an instance of Icon which will be shown in Marvin Sketch checker dialogs

Method Detail

getImplicitizeFlag

public int getImplicitizeFlag()

Returns the flag which can used to identify which hydrogens should be implicitize.

Returns:

the implicitize flag.

equals

public boolean equals(Object obj)

Overrides:

equals in class DefaultStructureCheckerResult

hashCode

public int hashCode()

Overrides:

hashCode in class DefaultStructureCheckerResult