Package chemaxon.checkers
Class StructureCheckerDescriptor
java.lang.Object
chemaxon.checkers.StructureCheckerDescriptor
- All Implemented Interfaces:
Cloneable
Descriptor for
StructureChecker
- Since:
- 5.7
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
action string token of the checkerstatic final String
custom name propertystatic final String
description of checkerstatic final String
editor class name property of checkerstatic final String
fix mode propertystatic final String
fixer class name propertystatic final String
help text for checkerstatic final String
icon path of checkerstatic final String
local menu name property of checkerstatic final String
multiple error message for checkerstatic final String
name property of checkerstatic final String
no error message for checkerstatic final String
single error message for checkerstatic final String
severity of checker -
Constructor Summary
ConstructorDescriptionStructureCheckerDescriptor
(Class<? extends StructureChecker> checkerClass) Constructs a descriptor based on checker class. -
Method Summary
Modifier and TypeMethodDescriptionvoid
Add a PropertyChangeListener to the listener list.void
addPropertyChangeListener
(String propertyName, PropertyChangeListener listener) Add a PropertyChangeListener for a specific property.clone()
boolean
String[]
Gets the action string token of the checkerReturns the customNameReturns the descriptionReturns the editorClassNameReturns the fixerClassNameReturns the fixModeReturns the help textgetIcon()
Returns theIcon
related to iconPath propertyReturns the icon pathReturns the checker identifierReturns the local menu nameReturns the more error messagegetName()
Returns the checker nameReturns the no error message of the concerning checkerReturns the one error messageReturns the severityint
hashCode()
void
Remove a PropertyChangeListener from the listener list.void
removePropertyChangeListener
(String propertyName, PropertyChangeListener listener) Remove a PropertyChangeListener for a specific property.void
setActionStringTokens
(String[] actionStringTokens) Sets the action string token of the checkervoid
setCustomName
(String customName) Sets the customNamevoid
setDescription
(String description) Sets the description of the concerning checkervoid
setEditorClassName
(String editorClassName) Sets the editorClassNamevoid
setFixerClassName
(String fixerClassName) Sets the fixerClassNamevoid
setFixMode
(FixMode fixMode) Sets the fixModevoid
setHelpText
(String helpText) Sets the help text of the concerning checkervoid
setIconPath
(String iconPath) Sets the icon pathvoid
setIdentifier
(String checkerId) Sets the checker identifiervoid
setLocalMenuName
(String localMenuName) Sets the local menu name of the concerning checkervoid
setMoreErrorMessage
(String moreErrorMessage) Sets the more error message of the concerning checkervoid
Sets the checker namevoid
setNoErrorMessage
(String noErrorMessage) Sets the no error message of the concerning checkervoid
setOneErrorMessage
(String oneErrorMessage) Sets the one error message of the concerning checkervoid
setSeverity
(CheckerSeverity severity) Sets the severity of the concerning checkertoString()
-
Field Details
-
CUSTOM_NAME
custom name property- See Also:
-
FIX_MODE
fix mode property- See Also:
-
FIXER_CLASS_NAME
fixer class name property- See Also:
-
EDITOR_CLASS_NAME
editor class name property of checker- See Also:
-
NAME
name property of checker- See Also:
-
LOCAL_MENU_NAME
local menu name property of checker- See Also:
-
NO_ERROR_MESSAGE
no error message for checker- See Also:
-
ONE_ERROR_MESSAGE
single error message for checker- See Also:
-
MORE_ERROR_MESSAGE
multiple error message for checker- See Also:
-
HELP_TEXT
help text for checker- See Also:
-
DESCRIPTION
description of checker- See Also:
-
ICON_PATH
icon path of checker- See Also:
-
SEVERITY
severity of checker- See Also:
-
ACTIONSTRING_TOKEN
action string token of the checker- See Also:
-
-
Constructor Details
-
StructureCheckerDescriptor
public StructureCheckerDescriptor(Class<? extends StructureChecker> checkerClass) throws 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:
IllegalArgumentException
- if the checkerClass is null
-
-
Method Details
-
getIdentifier
Returns the checker identifier- Returns:
- the checker identifier
-
setIdentifier
Sets the checker identifier- Parameters:
checkerId
- the checker identifier
-
getName
Returns the checker name- Returns:
- the checker name
-
setName
Sets the checker name- Parameters:
name
- the new name
-
getLocalMenuName
Returns the local menu name- Returns:
- the local menu name
-
setLocalMenuName
Sets the local menu name of the concerning checker- Parameters:
localMenuName
- is aString
object which represents the local menu name of the concerning checker
-
getNoErrorMessage
Returns the no error message of the concerning checker- Returns:
- the no error message
-
setNoErrorMessage
Sets the no error message of the concerning checker- Parameters:
noErrorMessage
- is aString
object which represents the message given by the concerned checker is no error found
-
getOneErrorMessage
Returns the one error message- Returns:
- the one error message
-
setOneErrorMessage
Sets the one error message of the concerning checker- Parameters:
oneErrorMessage
- is aString
object which represents the message given by the concerned checker if one error found
-
getMoreErrorMessage
Returns the more error message- Returns:
- the more error message
-
setMoreErrorMessage
Sets the more error message of the concerning checker- Parameters:
moreErrorMessage
- is aString
object which represents the message given by the concerned checker if more than one error found
-
getHelpText
Returns the help text- Returns:
- the help text
-
setHelpText
Sets the help text of the concerning checker- Parameters:
helpText
- is aString
object which represents the detailed help text of the concerning checker
-
getDescription
Returns the description- Returns:
- the description
-
setDescription
Sets the description of the concerning checker- Parameters:
description
- is aString
object which represents the description of the concerning checker
-
getIconPath
Returns the icon path- Returns:
- the icon path
-
setIconPath
Sets the icon path- Parameters:
iconPath
- represents the path of the icon image as aString
object
-
getEditorClassName
Returns the editorClassName- Returns:
- the editorClassName
-
setEditorClassName
Sets the editorClassName- Parameters:
editorClassName
- the editorClassName to set
-
getCustomName
Returns the customName- Returns:
- the customName
-
setCustomName
Sets the customName- Parameters:
customName
- the customName to set
-
getFixMode
Returns the fixMode- Returns:
- the fixMode
-
setFixMode
Sets the fixMode- Parameters:
fixMode
- the fixMode to set
-
getFixerClassName
Returns the fixerClassName- Returns:
- the fixerClassName
-
setFixerClassName
Sets the fixerClassName- Parameters:
fixerClassName
- the fixerClassName to set
-
getSeverity
Returns the severity- Returns:
- the severity
-
setSeverity
Sets the severity of the concerning checker- Parameters:
severity
- is an instance ofCheckerSeverity
which represents the severity of the concerning checker
-
getActionStringTokens
Gets the action string token of the checker- Returns:
- the action string token of the checker
-
setActionStringTokens
Sets the action string token of the checker- Parameters:
actionStringTokens
- the action string tokens of the checker
-
addPropertyChangeListener
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. Iflistener
is null, no exception is thrown and no action is taken.- Parameters:
listener
- The PropertyChangeListener to be added
-
removePropertyChangeListener
Remove a PropertyChangeListener from the listener list. This removes a PropertyChangeListener that was registered for all properties. Iflistener
was added more than once to the same event source, it will be notified one less time after being removed. Iflistener
is null, or was never added, no exception is thrown and no action is taken.- Parameters:
listener
- The PropertyChangeListener to be removed
-
addPropertyChangeListener
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. IfpropertyName
orlistener
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
Remove a PropertyChangeListener for a specific property. Iflistener
was added more than once to the same event source for the specified property, it will be notified one less time after being removed. IfpropertyName
is null, no exception is thrown and no action is taken. Iflistener
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() -
equals
-
toString
-
getIcon
Returns theIcon
related to iconPath property- Returns:
- the
Icon
related to iconPath property
-
clone
- Overrides:
clone
in classObject
- Throws:
CloneNotSupportedException
-