org.opendaylight.topoprocessing.api.structure

Class OverlayItem

java.lang.Object

org.opendaylight.topoprocessing.api.structure.OverlayItem

public class OverlayItem
extends Object

Author:

matus.marko, martin.uhlir

Constructor Summary

Constructors

Constructor and Description
OverlayItem(List<UnderlayItem> underlayItems, CorrelationItemEnum correlationItem) Creates overlay item.

Method Summary

Modifier and Type	Method and Description
void	addUnderlayItem(UnderlayItem underlayItem) Adds an underlay item to the list of items.
CorrelationItemEnum	getCorrelationItem()
Class<? extends CorrelationBase>	getCorrelationType()
Queue<UnderlayItem>	getUnderlayItems()
void	removeUnderlayItem(UnderlayItem itemToRemove) Removes underlay item from the list of items.
void	setCorrelationType(Class<? extends CorrelationBase> correlationType)
void	setUnderlayItems(Queue<UnderlayItem> underlayItems) Sets UnderlayItems.
void	updateUnderlayItem(UnderlayItem oldItem, UnderlayItem newItem) Update underlay item.

Methods inherited from class java.lang.Object

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

Constructor Detail

OverlayItem

public OverlayItem(List<UnderlayItem> underlayItems,
                   CorrelationItemEnum correlationItem)

Creates overlay item.

Parameters:

underlayItems - list of underlayItems that form this OverlayItem

correlationItem - type of underlayItems

Method Detail

addUnderlayItem

public void addUnderlayItem(UnderlayItem underlayItem)

Adds an underlay item to the list of items.

Parameters:

underlayItem - to be added

removeUnderlayItem

public void removeUnderlayItem(UnderlayItem itemToRemove)

Removes underlay item from the list of items.

Parameters:

itemToRemove - underlay item to be removed

updateUnderlayItem

public void updateUnderlayItem(UnderlayItem oldItem,
                               UnderlayItem newItem)

Update underlay item. Old item will be replaced by the new one.

Parameters:

oldItem - original item stored in topostore

newItem - updated item

getUnderlayItems

public Queue<UnderlayItem> getUnderlayItems()

Returns:

UnderlayItems (underlay items)

setUnderlayItems

public void setUnderlayItems(Queue<UnderlayItem> underlayItems)

Sets UnderlayItems.

Parameters:

underlayItems - underlay items

getCorrelationItem

public CorrelationItemEnum getCorrelationItem()

Returns:

correlation item: Node or Link or TerminationPoint

getCorrelationType

public Class<? extends CorrelationBase> getCorrelationType()

setCorrelationType

public void setCorrelationType(Class<? extends CorrelationBase> correlationType)