StructureCheckerDescriptor (JChem Base API documentation (c) 1998-2021 ChemAxon Ltd.)

java.lang.Object
- chemaxon.checkers.StructureCheckerDescriptor

All Implemented Interfaces:

java.lang.Cloneable
```
@PublicAPI
public final class StructureCheckerDescriptor
extends java.lang.Object
implements java.lang.Cloneable
```
Descriptor for StructureChecker

Since:

5.7

Author:

Istvan Rabel, Attila Szabo

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`ACTIONSTRING_TOKEN` action string token of the checker
`static java.lang.String`	`CUSTOM_NAME` custom name property
`static java.lang.String`	`DESCRIPTION` description of checker
`static java.lang.String`	`EDITOR_CLASS_NAME` editor class name property of checker
`static java.lang.String`	`FIX_MODE` fix mode property
`static java.lang.String`	`FIXER_CLASS_NAME` fixer class name property
`static java.lang.String`	`HELP_TEXT` help text for checker
`static java.lang.String`	`ICON_PATH` icon path of checker
`static java.lang.String`	`LOCAL_MENU_NAME` local menu name property of checker
`static java.lang.String`	`MORE_ERROR_MESSAGE` multiple error message for checker
`static java.lang.String`	`NAME` name property of checker
`static java.lang.String`	`NO_ERROR_MESSAGE` no error message for checker
`static java.lang.String`	`ONE_ERROR_MESSAGE` single error message for checker
`static java.lang.String`	`SEVERITY` severity of checker

Constructor Summary

Constructors
Constructor and Description

StructureCheckerDescriptor(java.lang.Class<? extends StructureChecker> checkerClass)
Constructs a descriptor based on checker class.

Constructors
Constructor and Description
`StructureCheckerDescriptor(java.lang.Class<? extends StructureChecker> checkerClass)` Constructs a descriptor based on checker class.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addPropertyChangeListener(java.beans.PropertyChangeListener listener)` Add a PropertyChangeListener to the listener list.
`void`	`addPropertyChangeListener(java.lang.String propertyName, java.beans.PropertyChangeListener listener)` Add a PropertyChangeListener for a specific property.
`StructureCheckerDescriptor`	`clone()`
`boolean`	`equals(java.lang.Object obj)`
`java.lang.String[]`	`getActionStringTokens()` Gets the action string token of the checker
`java.lang.String`	`getCustomName()` Returns the customName
`java.lang.String`	`getDescription()` Returns the description
`java.lang.String`	`getEditorClassName()` Returns the editorClassName
`java.lang.String`	`getFixerClassName()` Returns the fixerClassName
`FixMode`	`getFixMode()` Returns the fixMode
`java.lang.String`	`getHelpText()` Returns the help text
`javax.swing.Icon`	`getIcon()` Returns the `Icon` related to iconPath property
`java.lang.String`	`getIconPath()` Returns the icon path
`java.lang.String`	`getIdentifier()` Returns the checker identifier
`java.lang.String`	`getLocalMenuName()` Returns the local menu name
`java.lang.String`	`getMoreErrorMessage()` Returns the more error message
`java.lang.String`	`getName()` Returns the checker name
`java.lang.String`	`getNoErrorMessage()` Returns the no error message of the concerning checker
`java.lang.String`	`getOneErrorMessage()` Returns the one error message
`CheckerSeverity`	`getSeverity()` Returns the severity
`int`	`hashCode()`
`void`	`removePropertyChangeListener(java.beans.PropertyChangeListener listener)` Remove a PropertyChangeListener from the listener list.
`void`	`removePropertyChangeListener(java.lang.String propertyName, java.beans.PropertyChangeListener listener)` Remove a PropertyChangeListener for a specific property.
`void`	`setActionStringTokens(java.lang.String[] actionStringTokens)` Sets the action string token of the checker
`void`	`setCustomName(java.lang.String customName)` Sets the customName
`void`	`setDescription(java.lang.String description)` Sets the description of the concerning checker
`void`	`setEditorClassName(java.lang.String editorClassName)` Sets the editorClassName
`void`	`setFixerClassName(java.lang.String fixerClassName)` Sets the fixerClassName
`void`	`setFixMode(FixMode fixMode)` Sets the fixMode
`void`	`setHelpText(java.lang.String helpText)` Sets the help text of the concerning checker
`void`	`setIconPath(java.lang.String iconPath)` Sets the icon path
`void`	`setIdentifier(java.lang.String checkerId)` Sets the checker identifier
`void`	`setLocalMenuName(java.lang.String localMenuName)` Sets the local menu name of the concerning checker
`void`	`setMoreErrorMessage(java.lang.String moreErrorMessage)` Sets the more error message of the concerning checker
`void`	`setName(java.lang.String name)` Sets the checker name
`void`	`setNoErrorMessage(java.lang.String noErrorMessage)` Sets the no error message of the concerning checker
`void`	`setOneErrorMessage(java.lang.String oneErrorMessage)` Sets the one error message of the concerning checker
`void`	`setSeverity(CheckerSeverity severity)` Sets the severity of the concerning checker
`java.lang.String`	`toString()`

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - CUSTOM_NAME
```
public static final java.lang.String CUSTOM_NAME
```
    custom name property
    
    See Also:
    
    Constant Field Values
  - FIX_MODE
```
public static final java.lang.String FIX_MODE
```
    fix mode property
    
    See Also:
    
    Constant Field Values
  - FIXER_CLASS_NAME
```
public static final java.lang.String FIXER_CLASS_NAME
```
    fixer class name property
    
    See Also:
    
    Constant Field Values
  - EDITOR_CLASS_NAME
```
public static final java.lang.String EDITOR_CLASS_NAME
```
    editor class name property of checker
    
    See Also:
    
    Constant Field Values
  - NAME
```
public static final java.lang.String NAME
```
    name property of checker
    
    See Also:
    
    Constant Field Values
  - LOCAL_MENU_NAME
```
public static final java.lang.String LOCAL_MENU_NAME
```
    local menu name property of checker
    
    See Also:
    
    Constant Field Values
  - NO_ERROR_MESSAGE
```
public static final java.lang.String NO_ERROR_MESSAGE
```
    no error message for checker
    
    See Also:
    
    Constant Field Values
  - ONE_ERROR_MESSAGE
```
public static final java.lang.String ONE_ERROR_MESSAGE
```
    single error message for checker
    
    See Also:
    
    Constant Field Values
  - MORE_ERROR_MESSAGE
```
public static final java.lang.String MORE_ERROR_MESSAGE
```
    multiple error message for checker
    
    See Also:
    
    Constant Field Values
  - HELP_TEXT
```
public static final java.lang.String HELP_TEXT
```
    help text for checker
    
    See Also:
    
    Constant Field Values
  - DESCRIPTION
```
public static final java.lang.String DESCRIPTION
```
    description of checker
    
    See Also:
    
    Constant Field Values
  - ICON_PATH
```
public static final java.lang.String ICON_PATH
```
    icon path of checker
    
    See Also:
    
    Constant Field Values
  - SEVERITY
```
public static final java.lang.String SEVERITY
```
    severity of checker
    
    See Also:
    
    Constant Field Values
  - ACTIONSTRING_TOKEN
```
public static final java.lang.String ACTIONSTRING_TOKEN
```
    action string token of the checker
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - StructureCheckerDescriptor
```
public StructureCheckerDescriptor(java.lang.Class<? extends StructureChecker> checkerClass)
                           throws java.lang.IllegalArgumentException
```
    Constructs a descriptor based on checker class. CheckerInfo of specified class will be used for descriptor generation
    
    Parameters:
    
    checkerClass - the class used to generate descriptor
    
    Throws:
    
    java.lang.IllegalArgumentException - if the checkerClass is null
- Method Detail
  - getIdentifier
```
public java.lang.String getIdentifier()
```
    Returns the checker identifier
    
    Returns:
    
    the checker identifier
  - setIdentifier
```
public void setIdentifier(java.lang.String checkerId)
```
    Sets the checker identifier
    
    Parameters:
    
    checkerId - the checker identifier
  - getName
```
public java.lang.String getName()
```
    Returns the checker name
    
    Returns:
    
    the checker name
  - setName
```
public void setName(java.lang.String name)
```
    Sets the checker name
    
    Parameters:
    
    name - the new name
  - getLocalMenuName
```
public java.lang.String getLocalMenuName()
```
    Returns the local menu name
    
    Returns:
    
    the local menu name
  - setLocalMenuName
```
public void setLocalMenuName(java.lang.String localMenuName)
```
    Sets the local menu name of the concerning checker
    
    Parameters:
    
    localMenuName - is a String object which represents the local menu name of the concerning checker
  - getNoErrorMessage
```
public java.lang.String getNoErrorMessage()
```
    Returns the no error message of the concerning checker
    
    Returns:
    
    the no error message
  - setNoErrorMessage
```
public void setNoErrorMessage(java.lang.String noErrorMessage)
```
    Sets the no error message of the concerning checker
    
    Parameters:
    
    noErrorMessage - is a String object which represents the message given by the concerned checker is no error found
  - getOneErrorMessage
```
public java.lang.String getOneErrorMessage()
```
    Returns the one error message
    
    Returns:
    
    the one error message
  - setOneErrorMessage
```
public void setOneErrorMessage(java.lang.String oneErrorMessage)
```
    Sets the one error message of the concerning checker
    
    Parameters:
    
    oneErrorMessage - is a String object which represents the message given by the concerned checker if one error found
  - getMoreErrorMessage
```
public java.lang.String getMoreErrorMessage()
```
    Returns the more error message
    
    Returns:
    
    the more error message
  - setMoreErrorMessage
```
public void setMoreErrorMessage(java.lang.String moreErrorMessage)
```
    Sets the more error message of the concerning checker
    
    Parameters:
    
    moreErrorMessage - is a String object which represents the message given by the concerned checker if more than one error found
  - getHelpText
```
public java.lang.String getHelpText()
```
    Returns the help text
    
    Returns:
    
    the help text
  - setHelpText
```
public void setHelpText(java.lang.String helpText)
```
    Sets the help text of the concerning checker
    
    Parameters:
    
    helpText - is a String object which represents the detailed help text of the concerning checker
  - getDescription
```
public java.lang.String getDescription()
```
    Returns the description
    
    Returns:
    
    the description
  - setDescription
```
public void setDescription(java.lang.String description)
```
    Sets the description of the concerning checker
    
    Parameters:
    
    description - is a String object which represents the description of the concerning checker
  - getIconPath
```
public java.lang.String getIconPath()
```
    Returns the icon path
    
    Returns:
    
    the icon path
  - setIconPath
```
public void setIconPath(java.lang.String iconPath)
```
    Sets the icon path
    
    Parameters:
    
    iconPath - represents the path of the icon image as a String object
  - getEditorClassName
```
public java.lang.String getEditorClassName()
```
    Returns the editorClassName
    
    Returns:
    
    the editorClassName
  - setEditorClassName
```
public void setEditorClassName(java.lang.String editorClassName)
```
    Sets the editorClassName
    
    Parameters:
    
    editorClassName - the editorClassName to set
  - getCustomName
```
public java.lang.String getCustomName()
```
    Returns the customName
    
    Returns:
    
    the customName
  - setCustomName
```
public void setCustomName(java.lang.String customName)
```
    Sets the customName
    
    Parameters:
    
    customName - the customName to set
  - getFixMode
```
public FixMode getFixMode()
```
    Returns the fixMode
    
    Returns:
    
    the fixMode
  - setFixMode
```
public void setFixMode(FixMode fixMode)
```
    Sets the fixMode
    
    Parameters:
    
    fixMode - the fixMode to set
  - getFixerClassName
```
public java.lang.String getFixerClassName()
```
    Returns the fixerClassName
    
    Returns:
    
    the fixerClassName
  - setFixerClassName
```
public void setFixerClassName(java.lang.String fixerClassName)
```
    Sets the fixerClassName
    
    Parameters:
    
    fixerClassName - the fixerClassName to set
  - getSeverity
```
public CheckerSeverity getSeverity()
```
    Returns the severity
    
    Returns:
    
    the severity
  - setSeverity
```
public void setSeverity(CheckerSeverity severity)
```
    Sets the severity of the concerning checker
    
    Parameters:
    
    severity - is an instance of CheckerSeverity which represents the severity of the concerning checker
  - getActionStringTokens
```
public java.lang.String[] getActionStringTokens()
```
    Gets the action string token of the checker
    
    Returns:
    
    the action string token of the checker
  - setActionStringTokens
```
public void setActionStringTokens(java.lang.String[] actionStringTokens)
```
    Sets the action string token of the checker
    
    Parameters:
    
    actionStringTokens - the action string tokens of the checker
  - addPropertyChangeListener
```
public void addPropertyChangeListener(java.beans.PropertyChangeListener listener)
```
    Add a PropertyChangeListener to the listener list. The listener is registered for all properties. The same listener object may be added more than once, and will be called as many times as it is added. If listener is null, no exception is thrown and no action is taken.
    
    Parameters:
    
    listener - The PropertyChangeListener to be added
  - removePropertyChangeListener
```
public void removePropertyChangeListener(java.beans.PropertyChangeListener listener)
```
    Remove a PropertyChangeListener from the listener list. This removes a PropertyChangeListener that was registered for all properties. If listener was added more than once to the same event source, it will be notified one less time after being removed. If listener is null, or was never added, no exception is thrown and no action is taken.
    
    Parameters:
    
    listener - The PropertyChangeListener to be removed
  - addPropertyChangeListener
```
public void addPropertyChangeListener(java.lang.String propertyName,
                                      java.beans.PropertyChangeListener listener)
```
    Add a PropertyChangeListener for a specific property. The listener will be invoked only when a call on firePropertyChange names that specific property. The same listener object may be added more than once. For each property, the listener will be invoked the number of times it was added for that property. If propertyName or listener is null, no exception is thrown and no action is taken.
    
    Parameters:
    
    propertyName - The name of the property to listen on.
    
    listener - The PropertyChangeListener to be added
  - removePropertyChangeListener
```
public void removePropertyChangeListener(java.lang.String propertyName,
                                         java.beans.PropertyChangeListener listener)
```
    Remove a PropertyChangeListener for a specific property. If listener was added more than once to the same event source for the specified property, it will be notified one less time after being removed. If propertyName is null, no exception is thrown and no action is taken. If listener is null, or was never added for the specified property, no exception is thrown and no action is taken.
    
    Parameters:
    
    propertyName - The name of the property that was listened on.
    
    listener - The PropertyChangeListener to be removed
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Overrides:
    
    equals in class java.lang.Object
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - getIcon
```
public javax.swing.Icon getIcon()
```
    Returns the Icon related to iconPath property
    
    Returns:
    
    the Icon related to iconPath property
  - clone
```
public StructureCheckerDescriptor clone()
                                 throws java.lang.CloneNotSupportedException
```
    Overrides:
    
    clone in class java.lang.Object
    
    Throws:
    
    java.lang.CloneNotSupportedException

Class StructureCheckerDescriptor

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

CUSTOM_NAME

FIX_MODE

FIXER_CLASS_NAME

EDITOR_CLASS_NAME

NAME

LOCAL_MENU_NAME

NO_ERROR_MESSAGE

ONE_ERROR_MESSAGE

MORE_ERROR_MESSAGE

HELP_TEXT

DESCRIPTION

ICON_PATH

SEVERITY

ACTIONSTRING_TOKEN

Constructor Detail

StructureCheckerDescriptor

Method Detail

getIdentifier

setIdentifier

getName

setName

getLocalMenuName

setLocalMenuName

getNoErrorMessage

setNoErrorMessage

getOneErrorMessage

setOneErrorMessage

getMoreErrorMessage

setMoreErrorMessage

getHelpText

setHelpText

getDescription

setDescription

getIconPath

setIconPath

getEditorClassName

setEditorClassName

getCustomName

setCustomName

getFixMode

setFixMode

getFixerClassName

setFixerClassName

getSeverity

setSeverity

getActionStringTokens

setActionStringTokens

addPropertyChangeListener

removePropertyChangeListener

addPropertyChangeListener

removePropertyChangeListener

hashCode

equals

toString

getIcon

clone