org.eclipse.emf.compare.diff.service
Class DiffEngineDescriptor

java.lang.Object
  org.eclipse.emf.compare.diff.service.DiffEngineDescriptor

All Implemented Interfaces:

java.lang.Comparable<DiffEngineDescriptor>

public class DiffEngineDescriptor
extends java.lang.Object
implements java.lang.Comparable<DiffEngineDescriptor>

The engine descriptor represents an engine contribution trough the extension point.

Field Summary

protected org.eclipse.core.runtime.IConfigurationElement	element Configuration element of this descriptor.
protected java.lang.String	engineClassName Class name of this engine.
protected java.lang.String	fileExtension File extensions this engine takes into account.
protected java.lang.String	icon Icon of this engine.
protected java.lang.String	label Label of this engine.
protected java.lang.String	priority Priority of this descriptor.

Constructor Summary

DiffEngineDescriptor(org.eclipse.core.runtime.IConfigurationElement configuration)
Instantiate the descriptor given its configuration.

Method Summary

int	compareTo(DiffEngineDescriptor other)
boolean	equals(java.lang.Object obj)
org.eclipse.core.runtime.IConfigurationElement	getElement() Returns the configuration element.
java.lang.String	getEngineClassName() Returns the qualified name of the engine's class.
IDiffEngine	getEngineInstance() Returns the engine instance.
java.lang.String	getFileExtension() Returns the file extension this engine should handle.
java.lang.String	getIcon() Returns the icon that represents the wrapped engine.
java.lang.String	getLabel() Returns the label that represents the wrapped engine.
java.lang.String	getPriority() Returns the engine priority.
int	getPriorityValue() Returns the value of the priority of this engine.
int	hashCode()

Methods inherited from class java.lang.Object

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

Field Detail

element

protected final org.eclipse.core.runtime.IConfigurationElement element

Configuration element of this descriptor.

engineClassName

protected final java.lang.String engineClassName

Class name of this engine.

fileExtension

protected final java.lang.String fileExtension

File extensions this engine takes into account.

label

protected final java.lang.String label

Label of this engine.

icon

protected final java.lang.String icon

Icon of this engine.

priority

protected final java.lang.String priority

Priority of this descriptor. Should be one of

• EngineConstants.PRIORITY_HIGHEST
• EngineConstants.PRIORITY_HIGH
• EngineConstants.PRIORITY_NORMAL
• EngineConstants.PRIORITY_LOW
• EngineConstants.PRIORITY_LOWEST

Constructor Detail

DiffEngineDescriptor

public DiffEngineDescriptor(org.eclipse.core.runtime.IConfigurationElement configuration)

Instantiate the descriptor given its configuration.

Parameters:

configuration - configuration element of this descriptor.

Method Detail

compareTo

public int compareTo(DiffEngineDescriptor other)

Specified by:

compareTo in interface java.lang.Comparable<DiffEngineDescriptor>

See Also:

Comparable.compareTo(java.lang.Object)

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

See Also:

Object.equals(java.lang.Object)

getElement

public org.eclipse.core.runtime.IConfigurationElement getElement()

Returns the configuration element.

Returns:

The configuration element.

Since:

0.9

getEngineClassName

public java.lang.String getEngineClassName()

Returns the qualified name of the engine's class.

Returns:

Qualified name of the engine's class.

Since:

0.9

getEngineInstance

public IDiffEngine getEngineInstance()

Returns the engine instance.

Returns:

The engine instance.

getFileExtension

public java.lang.String getFileExtension()

Returns the file extension this engine should handle.

Returns:

The file extension this engine should handle.

getIcon

public java.lang.String getIcon()

Returns the icon that represents the wrapped engine.

Returns:

The icon that represents the wrapped engine.

Since:

0.9

getLabel

public java.lang.String getLabel()

Returns the label that represents the wrapped engine.

Returns:

The label that represents the wrapped engine.

Since:

0.9

getPriority

public java.lang.String getPriority()

Returns the engine priority.

Returns:

The engine priority.

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

See Also:

Object.hashCode()

getPriorityValue

public int getPriorityValue()

Returns the value of the priority of this engine.
Returned values according to priority :

• "lowest" =>
• "low" =>
• "high" =>
• "highest" =>
• anything else =>

Returns:

int corresponding to this engine priority.