Package chemaxon.fixers
Class StructureFixerDescriptor
- java.lang.Object
-
- chemaxon.fixers.StructureFixerDescriptor
-
- All Implemented Interfaces:
Cloneable
@PublicAPI public class StructureFixerDescriptor extends Object implements Cloneable
Descriptor class forStructureFixer
classes.- Since:
- 5.9
-
-
Field Summary
Fields Modifier and Type Field Description static String
ACTIONSTRING_TOKEN
action string tokens of the fixerstatic int
DEFAULT_PRIORITY
the default priority valuestatic String
DESCRIPTION
description of fixerstatic int
HIGH_PRIORITY
high priority valuestatic int
HIGHEST_PRIORITY
the highest priority valuestatic int
LOW_PRIORITY
low priority valuestatic int
LOWEST_PRIORITY
the lowest priority valuestatic String
NAME
name property of fixerstatic String
PRIORITY
priority of fixer
-
Constructor Summary
Constructors Constructor Description StructureFixerDescriptor(Class<? extends StructureFixer> fixerClass)
Constructs a descriptor based on fixer class.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
addPropertyChangeListener(PropertyChangeListener listener)
Add a PropertyChangeListener to the listener list.void
addPropertyChangeListener(String propertyName, PropertyChangeListener listener)
Add a PropertyChangeListener for a specific property.StructureFixerDescriptor
clone()
boolean
equals(Object obj)
String[]
getActionStringTokens()
Gets the action string token of the fixerString
getDescription()
Returns the descriptionString
getIdentifier()
Returns the fixer identifierString
getName()
Returns the fixer nameint
getPriority()
Returns the fixer priority.int
hashCode()
void
removePropertyChangeListener(PropertyChangeListener listener)
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 fixervoid
setDescription(String description)
Sets the description of the concerning fixervoid
setIdentifier(String fixerId)
Sets the fixer identifiervoid
setName(String name)
Sets the fixer namevoid
setPriority(int priority)
Sets the fixer priority.String
toString()
-
-
-
Field Detail
-
NAME
public static final String NAME
name property of fixer- See Also:
- Constant Field Values
-
DESCRIPTION
public static final String DESCRIPTION
description of fixer- See Also:
- Constant Field Values
-
PRIORITY
public static final String PRIORITY
priority of fixer- See Also:
- Constant Field Values
-
LOWEST_PRIORITY
public static final int LOWEST_PRIORITY
the lowest priority value- See Also:
- Constant Field Values
-
LOW_PRIORITY
public static final int LOW_PRIORITY
low priority value- See Also:
- Constant Field Values
-
DEFAULT_PRIORITY
public static final int DEFAULT_PRIORITY
the default priority value- See Also:
- Constant Field Values
-
HIGH_PRIORITY
public static final int HIGH_PRIORITY
high priority value- See Also:
- Constant Field Values
-
HIGHEST_PRIORITY
public static final int HIGHEST_PRIORITY
the highest priority value- See Also:
- Constant Field Values
-
ACTIONSTRING_TOKEN
public static final String ACTIONSTRING_TOKEN
action string tokens of the fixer- See Also:
- Constant Field Values
-
-
Constructor Detail
-
StructureFixerDescriptor
public StructureFixerDescriptor(Class<? extends StructureFixer> fixerClass) throws IllegalArgumentException
Constructs a descriptor based on fixer class.FixerInfo
of specified class will be used for descriptor generation- Parameters:
fixerClass
- the class used to generate descriptor- Throws:
IllegalArgumentException
- if the fixerClass is null
-
-
Method Detail
-
getIdentifier
public String getIdentifier()
Returns the fixer identifier- Returns:
- the fixer identifier
-
setIdentifier
public void setIdentifier(String fixerId)
Sets the fixer identifier- Parameters:
fixerId
- the fixer identifier to set
-
getName
public String getName()
Returns the fixer name- Returns:
- the fixer name
-
setName
public void setName(String name)
Sets the fixer name- Parameters:
name
- the new name
-
getDescription
public String getDescription()
Returns the description- Returns:
- the description
-
setDescription
public void setDescription(String description)
Sets the description of the concerning fixer- Parameters:
description
- is aString
object which represents the description of the concerning fixer
-
getPriority
public int getPriority()
Returns the fixer priority.- Returns:
- the priority of the fixer
- Since:
- 5.12
-
setPriority
public void setPriority(int priority)
Sets the fixer priority.- Parameters:
priority
- the new priority- Since:
- 5.12
-
getActionStringTokens
public String[] getActionStringTokens()
Gets the action string token of the fixer- Returns:
- the action string token of the fixer
-
setActionStringTokens
public void setActionStringTokens(String[] actionStringTokens)
Sets the action string token of the fixer- Parameters:
actionStringTokens
- the action string tokens of the fixer
-
addPropertyChangeListener
public void addPropertyChangeListener(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. Iflistener
is null, no exception is thrown and no action is taken.- Parameters:
listener
- The PropertyChangeListener to be added
-
removePropertyChangeListener
public void removePropertyChangeListener(PropertyChangeListener listener)
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
public void addPropertyChangeListener(String propertyName, 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. 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
public void removePropertyChangeListener(String propertyName, PropertyChangeListener listener)
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
-
clone
public StructureFixerDescriptor clone() throws CloneNotSupportedException
- Overrides:
clone
in classObject
- Throws:
CloneNotSupportedException
-
-