org.onosproject.ui.impl

Class TopoOverlayCache

java.lang.Object

org.onosproject.ui.impl.TopoOverlayCache

public class TopoOverlayCache
extends Object

A cache of UiTopoOverlay's that were registered at the time the UI connection was established.

Constructor Summary

Constructors

Constructor and Description
TopoOverlayCache()

Method Summary

Modifier and Type	Method and Description
void	add(org.onosproject.ui.UiTopoOverlay overlay) Adds a topology overlay to the cache.
org.onosproject.ui.UiTopoOverlay	currentOverlay() Returns the current overlay instance.
void	destroy() Invoked when the cache is no longer needed.
boolean	isActive(String overlayId) Returns true if the identifier of the currently active overlay matches the given parameter.
int	size() Returns the number of overlays in the cache.
void	switchOverlay(String deact, String act) Switching currently selected overlay.

Methods inherited from class java.lang.Object

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

Constructor Detail

TopoOverlayCache

public TopoOverlayCache()

Method Detail

add

public void add(org.onosproject.ui.UiTopoOverlay overlay)

Adds a topology overlay to the cache.

Parameters:

overlay - a topology overlay

destroy

public void destroy()

Invoked when the cache is no longer needed.

switchOverlay

public void switchOverlay(String deact,
                          String act)

Switching currently selected overlay.

Parameters:

deact - identity of overlay to deactivate

act - identity of overlay to activate

currentOverlay

public org.onosproject.ui.UiTopoOverlay currentOverlay()

Returns the current overlay instance. Note that this method always returns a reference; when there is no overlay selected the "NULL" overlay instance is returned.

Returns:

the current overlay

size

public int size()

Returns the number of overlays in the cache. Remember that this includes the "NULL" overlay, representing "no overlay selected".

Returns:

number of overlays

isActive

public boolean isActive(String overlayId)

Returns true if the identifier of the currently active overlay matches the given parameter.

Parameters:

overlayId - overlay identifier

Returns:

true if this matches the ID of currently active overlay