@PublicAPI public final class StructureCheckerDescriptor extends java.lang.Object implements java.lang.Cloneable
StructureChecker
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 and Description |
---|
StructureCheckerDescriptor(java.lang.Class<? extends StructureChecker> checkerClass)
Constructs a descriptor based on checker class.
|
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() |
public static final java.lang.String CUSTOM_NAME
public static final java.lang.String FIX_MODE
public static final java.lang.String FIXER_CLASS_NAME
public static final java.lang.String EDITOR_CLASS_NAME
public static final java.lang.String NAME
public static final java.lang.String LOCAL_MENU_NAME
public static final java.lang.String NO_ERROR_MESSAGE
public static final java.lang.String ONE_ERROR_MESSAGE
public static final java.lang.String MORE_ERROR_MESSAGE
public static final java.lang.String HELP_TEXT
public static final java.lang.String DESCRIPTION
public static final java.lang.String ICON_PATH
public static final java.lang.String SEVERITY
public static final java.lang.String ACTIONSTRING_TOKEN
public StructureCheckerDescriptor(java.lang.Class<? extends StructureChecker> checkerClass) throws java.lang.IllegalArgumentException
CheckerInfo
of specified class will be used for descriptor generationcheckerClass
- the class used to generate descriptorjava.lang.IllegalArgumentException
- if the checkerClass is nullpublic java.lang.String getIdentifier()
public void setIdentifier(java.lang.String checkerId)
checkerId
- the checker identifierpublic java.lang.String getName()
public void setName(java.lang.String name)
name
- the new namepublic java.lang.String getLocalMenuName()
public void setLocalMenuName(java.lang.String localMenuName)
localMenuName
- is a String
object which represents the local menu name of
the concerning checkerpublic java.lang.String getNoErrorMessage()
public void setNoErrorMessage(java.lang.String noErrorMessage)
noErrorMessage
- is a String
object which represents the message given by
the concerned checker is no error foundpublic java.lang.String getOneErrorMessage()
public void setOneErrorMessage(java.lang.String oneErrorMessage)
oneErrorMessage
- is a String
object which represents the message given by
the concerned checker if one error foundpublic java.lang.String getMoreErrorMessage()
public void setMoreErrorMessage(java.lang.String moreErrorMessage)
moreErrorMessage
- is a String
object which represents the message given by
the concerned checker if more than one error foundpublic java.lang.String getHelpText()
public void setHelpText(java.lang.String helpText)
helpText
- is a String
object which represents the detailed help text of the
concerning checkerpublic java.lang.String getDescription()
public void setDescription(java.lang.String description)
description
- is a String
object which represents the description of
the concerning checkerpublic java.lang.String getIconPath()
public void setIconPath(java.lang.String iconPath)
iconPath
- represents the path of the icon image as a String
objectpublic java.lang.String getEditorClassName()
public void setEditorClassName(java.lang.String editorClassName)
editorClassName
- the editorClassName to setpublic java.lang.String getCustomName()
public void setCustomName(java.lang.String customName)
customName
- the customName to setpublic FixMode getFixMode()
public void setFixMode(FixMode fixMode)
fixMode
- the fixMode to setpublic java.lang.String getFixerClassName()
public void setFixerClassName(java.lang.String fixerClassName)
fixerClassName
- the fixerClassName to setpublic CheckerSeverity getSeverity()
public void setSeverity(CheckerSeverity severity)
severity
- is an instance of CheckerSeverity
which represents the severity
of the concerning checkerpublic java.lang.String[] getActionStringTokens()
public void setActionStringTokens(java.lang.String[] actionStringTokens)
actionStringTokens
- the action string tokens of the checkerpublic void addPropertyChangeListener(java.beans.PropertyChangeListener listener)
listener
is null, no exception is thrown and no action
is taken.listener
- The PropertyChangeListener to be addedpublic void removePropertyChangeListener(java.beans.PropertyChangeListener listener)
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.listener
- The PropertyChangeListener to be removedpublic void addPropertyChangeListener(java.lang.String propertyName, java.beans.PropertyChangeListener listener)
propertyName
or listener
is null, no
exception is thrown and no action is taken.propertyName
- The name of the property to listen on.listener
- The PropertyChangeListener to be addedpublic void removePropertyChangeListener(java.lang.String propertyName, java.beans.PropertyChangeListener listener)
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.propertyName
- The name of the property that was listened on.listener
- The PropertyChangeListener to be removedpublic int hashCode()
hashCode
in class java.lang.Object
public boolean equals(java.lang.Object obj)
equals
in class java.lang.Object
public java.lang.String toString()
toString
in class java.lang.Object
public javax.swing.Icon getIcon()
Icon
related to iconPath propertyIcon
related to iconPath propertypublic StructureCheckerDescriptor clone() throws java.lang.CloneNotSupportedException
clone
in class java.lang.Object
java.lang.CloneNotSupportedException