chemaxon.fixers

Class StructureFixerDescriptor

java.lang.Object

chemaxon.fixers.StructureFixerDescriptor

All Implemented Interfaces:

java.lang.Cloneable

@PublicAPI
public class StructureFixerDescriptor
extends java.lang.Object
implements java.lang.Cloneable

Descriptor class for StructureFixer classes.

Since:

5.9

Author:

Imre Barna

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ACTIONSTRING_TOKEN action string tokens of the fixer
static int	DEFAULT_PRIORITY the default priority value
static java.lang.String	DESCRIPTION description of fixer
static int	HIGH_PRIORITY high priority value
static int	HIGHEST_PRIORITY the highest priority value
static int	LOW_PRIORITY low priority value
static int	LOWEST_PRIORITY the lowest priority value
static java.lang.String	NAME name property of fixer
static java.lang.String	PRIORITY priority of fixer

Constructor Summary

Constructors

Constructor and Description
StructureFixerDescriptor(java.lang.Class<? extends StructureFixer> fixerClass) Constructs a descriptor based on fixer class.

Method Summary

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.
StructureFixerDescriptor	clone()
boolean	equals(java.lang.Object obj)
java.lang.String[]	getActionStringTokens() Gets the action string token of the fixer
java.lang.String	getDescription() Returns the description
java.lang.String	getIdentifier() Returns the fixer identifier
java.lang.String	getName() Returns the fixer name
int	getPriority() Returns the fixer priority.
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 fixer
void	setDescription(java.lang.String description) Sets the description of the concerning fixer
void	setIdentifier(java.lang.String fixerId) Sets the fixer identifier
void	setName(java.lang.String name) Sets the fixer name
void	setPriority(int priority) Sets the fixer priority.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

NAME

public static final java.lang.String NAME

name property of fixer

See Also:

Constant Field Values

DESCRIPTION

public static final java.lang.String DESCRIPTION

description of fixer

See Also:

Constant Field Values

PRIORITY

public static final java.lang.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 java.lang.String ACTIONSTRING_TOKEN

action string tokens of the fixer

See Also:

Constant Field Values

Constructor Detail

StructureFixerDescriptor

public StructureFixerDescriptor(java.lang.Class<? extends StructureFixer> fixerClass)
                         throws java.lang.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:

java.lang.IllegalArgumentException - if the fixerClass is null

Method Detail

getIdentifier

public java.lang.String getIdentifier()

Returns the fixer identifier

Returns:

the fixer identifier

setIdentifier

public void setIdentifier(java.lang.String fixerId)

Sets the fixer identifier

Parameters:

fixerId - the fixer identifier to set

getName

public java.lang.String getName()

Returns the fixer name

Returns:

the fixer name

setName

public void setName(java.lang.String name)

Sets the fixer name

Parameters:

name - the new name

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 fixer

Parameters:

description - is a String 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 java.lang.String[] getActionStringTokens()

Gets the action string token of the fixer

Returns:

the action string token of the fixer

setActionStringTokens

public void setActionStringTokens(java.lang.String[] actionStringTokens)

Sets the action string token of the fixer

Parameters:

actionStringTokens - the action string tokens of the fixer

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

clone

public StructureFixerDescriptor clone()
                               throws java.lang.CloneNotSupportedException

Overrides:

clone in class java.lang.Object

Throws:

java.lang.CloneNotSupportedException