oracle.jdeveloper.vcs.spi

Class VCSOverlayItemProducer

java.lang.Object

oracle.jdeveloper.vcs.spi.VCSOverlayItemProducer

public class VCSOverlayItemProducer
extends java.lang.Object

Class for the return of status items with an overlay representation.

Since:

10.1.3.0.1

Constructor Summary

Constructors

Constructor and Description
VCSOverlayItemProducer(java.lang.String extensionId, oracle.jdeveloper.vcs.cache.StatusCacheBridge<VCSStatus> statusCache) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
java.util.Observable	getObservable() Gets the observable object overlay item changes.
VCSOverlayItem[]	getOverlayItems(java.net.URL[] urls) Gets overlay information describing the statuses.
oracle.jdeveloper.vcs.cache.StatusCache<VCSStatus>	getPolicyStatusCache()
protected VCSPreferences	getPreferences(PropertyStorage prefs)
VCSStatusCache	getStatusCache() Deprecated. replaced by getStatusCacheBridge() and getPolicyStatusCache().
oracle.jdeveloper.vcs.cache.StatusCacheBridge<VCSStatus>	getStatusCacheBridge()
void	preferencesChanged()
protected IconOverlay	produceOverlay(java.net.URL url, VCSStatus status) Produce the overlay object for the given URL and status.
protected IconOverlay	produceOverlay(java.net.URL url, VCSStatus status, VCSPreferences prefs)
protected IconOverlay[]	produceOverlays(java.net.URL[] urls, VCSStatus[] statuses)
protected IconOverlay[]	produceOverlays(java.net.URL[] urls, VCSStatus[] statuses, VCSPreferences prefs)

Methods inherited from class java.lang.Object

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

Constructor Detail

VCSOverlayItemProducer

public VCSOverlayItemProducer(java.lang.String extensionId,
                      oracle.jdeveloper.vcs.cache.StatusCacheBridge<VCSStatus> statusCache)

Constructor.

Parameters:

statusCache - the delegate status cache.

Method Detail

getStatusCache

@Deprecated
public VCSStatusCache getStatusCache()

Deprecated. replaced by getStatusCacheBridge() and getPolicyStatusCache().

Gets the internal version status cache.

Returns:

the status cache.

getPolicyStatusCache

public oracle.jdeveloper.vcs.cache.StatusCache<VCSStatus> getPolicyStatusCache()

getStatusCacheBridge

public oracle.jdeveloper.vcs.cache.StatusCacheBridge<VCSStatus> getStatusCacheBridge()

getObservable

public java.util.Observable getObservable()

Gets the observable object overlay item changes.

Returns:

the observable object.

getOverlayItems

public VCSOverlayItem[] getOverlayItems(java.net.URL[] urls)
                                 throws java.lang.Exception

Gets overlay information describing the statuses.

Returns:

the overlay objects.

Throws:

java.lang.Exception

produceOverlays

protected IconOverlay[] produceOverlays(java.net.URL[] urls,
                            VCSStatus[] statuses)
                                 throws java.lang.Exception

Throws:

java.lang.Exception

produceOverlays

protected IconOverlay[] produceOverlays(java.net.URL[] urls,
                            VCSStatus[] statuses,
                            VCSPreferences prefs)
                                 throws java.lang.Exception

Throws:

java.lang.Exception

produceOverlay

protected IconOverlay produceOverlay(java.net.URL url,
                         VCSStatus status)
                              throws java.lang.Exception

Produce the overlay object for the given URL and status. Override this method to apply any necessary transformations to the default overlay associated with the status.

Parameters:

url - the URL.

status - the status object.

Returns:

the overlay object for the

Throws:

java.lang.Exception

produceOverlay

protected IconOverlay produceOverlay(java.net.URL url,
                         VCSStatus status,
                         VCSPreferences prefs)
                              throws java.lang.Exception

Throws:

java.lang.Exception

preferencesChanged

public void preferencesChanged()

getPreferences

protected VCSPreferences getPreferences(PropertyStorage prefs)