oracle.ide.quickdiff

Class QuickDiffReferenceProvider

java.lang.Object

oracle.ide.quickdiff.QuickDiffReferenceProvider

Direct Known Subclasses:

VCSQuickDiffReferenceProvider

public abstract class QuickDiffReferenceProvider
extends java.lang.Object

Class that provides a comparable Quick Diff reference and specifies how it should be represented in the UI.

Since:

11.1.1.0.0 (Bulldog)

Constructor Summary

Constructors

Constructor and Description
QuickDiffReferenceProvider()

Method Summary

Modifier and Type	Method and Description
abstract QuickDiffReference	createReference(java.net.URL url) Creates an observable QuickDiffReference for the given URL value.
abstract java.lang.String	getID() Gets the ID against which this reference provider is registered.
float	getMenuSection() Gets a section identifier for the menu item representing this reference type in the UI.
abstract java.lang.String	getName() Gets the human-readable name used to describe the reference type in the UI.
boolean	isAvailable(java.net.URL url) Asks whether this reference type should be made available for the given URL.

Methods inherited from class java.lang.Object

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

Constructor Detail

QuickDiffReferenceProvider

public QuickDiffReferenceProvider()

Method Detail

getID

public abstract java.lang.String getID()

Gets the ID against which this reference provider is registered.

Returns:

the ID value.

getName

public abstract java.lang.String getName()

Gets the human-readable name used to describe the reference type in the UI.

Returns:

the name of the reference provider.

getMenuSection

public float getMenuSection()

Gets a section identifier for the menu item representing this reference type in the UI. By default, returns QuickDiffMenuConstants.SECTION_ADDITIONAL_REFERENCES.

Returns:

a section value.

isAvailable

public boolean isAvailable(java.net.URL url)

Asks whether this reference type should be made available for the given URL.

Parameters:

url - the URL.

Returns:

a verdict on whether the reference type can be made available.

createReference

public abstract QuickDiffReference createReference(java.net.URL url)

Creates an observable QuickDiffReference for the given URL value.

Parameters:

url - the URL of the reference.

Returns:

the new QuickDiffReference backed by the URL.