oracle.javatools.compare
Class CompareContributor

java.lang.Object
  oracle.javatools.compare.CompareContributor

Direct Known Subclasses:

oracle.javatools.compare.algorithm.sequence.SequenceCompareContributor

public abstract class CompareContributor
extends java.lang.Object

The base class for a single participant in compare.

Since:

10.0.3

Constructor Summary

CompareContributor()

Method Summary

void	addPropertyChangeListener(java.beans.PropertyChangeListener listener) Add a listener to be notified when properties of this bean change.
void	addPropertyChangeListener(java.lang.String propertyName, java.beans.PropertyChangeListener listener) Add a listener to be notified when properties of this bean change.
java.lang.String	getLongLabel() Get a long label for this comparable element.
java.lang.Object	getProperty(java.lang.String name)
protected java.beans.PropertyChangeSupport	getPropertyChangeSupport() Get the property change support for this contributor.
java.lang.String	getShortLabel() Get a short label for this comparable element.
java.lang.String	getType() Get the extension of the file this contributor represents.
void	removePropertyChangeListener(java.beans.PropertyChangeListener listener) Remove a property change listener.
void	setLongLabel(java.lang.String longLabel) Set a long label for this comparable element.
void	setProperty(java.lang.String name, java.lang.Object value)
void	setShortLabel(java.lang.String shortLabel) Set a short label for this comparable element.
void	setType(java.lang.String type) Set the extension of the file this contributor represents.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CompareContributor

public CompareContributor()

Method Detail

getShortLabel

public java.lang.String getShortLabel()

Get a short label for this comparable element.

Returns:

a short label for this comparable element.

setShortLabel

public void setShortLabel(java.lang.String shortLabel)

Set a short label for this comparable element.

Parameters:

shortLabel - short label for this comparable element.

getLongLabel

public java.lang.String getLongLabel()

Get a long label for this comparable element.

Returns:

a long label for this comparable element.

setLongLabel

public void setLongLabel(java.lang.String longLabel)

Set a long label for this comparable element.

Parameters:

longLabel - a long label for this comparable element.

getType

public java.lang.String getType()

Get the extension of the file this contributor represents. This is currently only used to determine the syntax highlighting style for the text compare viewer, but it will almost certainly be used for other things in the future. By default, this method returns an empty string.

Returns:

an extension for this file without any period prefix. E.g. "java".

setType

public void setType(java.lang.String type)

Set the extension of the file this contributor represents.

Parameters:

type - an extension for this file without any period prefix. E.g. "java".

getPropertyChangeSupport

protected java.beans.PropertyChangeSupport getPropertyChangeSupport()

Get the property change support for this contributor. This may be null if nobody is listening.

addPropertyChangeListener

public void addPropertyChangeListener(java.lang.String propertyName,
                                      java.beans.PropertyChangeListener listener)

Add a listener to be notified when properties of this bean change.

Parameters:

propertyName - the property to listen for changes to

listener - the listener to add

addPropertyChangeListener

public void addPropertyChangeListener(java.beans.PropertyChangeListener listener)

Add a listener to be notified when properties of this bean change.

Parameters:

listener - the listener to add

removePropertyChangeListener

public void removePropertyChangeListener(java.beans.PropertyChangeListener listener)

Remove a property change listener.

Parameters:

listener - the listener to remove

getProperty

public final java.lang.Object getProperty(java.lang.String name)

setProperty

public final void setProperty(java.lang.String name,
                              java.lang.Object value)