org.onosproject.ui.impl.topo.util

Class IntentSelection

java.lang.Object

org.onosproject.ui.impl.topo.util.IntentSelection

public class IntentSelection
extends Object

Encapsulates a selection of intents (paths) inferred from a selection of devices and/or hosts from the topology view.

Field Summary

Fields

Modifier and Type	Field and Description
protected static org.slf4j.Logger	log

Constructor Summary

Constructors

Constructor and Description
IntentSelection(org.onosproject.net.intent.Intent intent) Creates an intent selection group, for a single intent.
IntentSelection(org.onosproject.ui.topo.NodeSelection nodes, TopoIntentFilter filter) Creates an intent selection group, based on selected nodes.

Method Summary

Modifier and Type	Method and Description
boolean	all() Returns true if all intents in this select group are currently selected.
org.onosproject.net.intent.Intent	current() Returns the currently marked intent, or null if "all" intents are marked.
int	index() Returns the index of the currently selected intent.
List<org.onosproject.net.intent.Intent>	intents() The list of intents in this selection group.
org.onosproject.net.intent.Intent	next() Marks and returns the next intent in this group.
boolean	none() Returns true if no intents are selected.
org.onosproject.net.intent.Intent	prev() Marks and returns the previous intent in this group.
boolean	single() Returns true if there is a single intent in this select group, or if a specific intent has been marked (index != ALL).
int	size() Returns the number of intents in this selection group.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

log

protected static final org.slf4j.Logger log

Constructor Detail

IntentSelection

public IntentSelection(org.onosproject.ui.topo.NodeSelection nodes,
                       TopoIntentFilter filter)

Creates an intent selection group, based on selected nodes.

Parameters:

nodes - node selection

filter - intent filter

IntentSelection

public IntentSelection(org.onosproject.net.intent.Intent intent)

Creates an intent selection group, for a single intent.

Parameters:

intent - the intent

Method Detail

none

public boolean none()

Returns true if no intents are selected.

Returns:

true if nothing selected

all

public boolean all()

Returns true if all intents in this select group are currently selected. This is the initial state, so that all intents are shown on the topology view with primary highlighting.

Returns:

true if all selected

single

public boolean single()

Returns true if there is a single intent in this select group, or if a specific intent has been marked (index != ALL).

Returns:

true if single intent marked

size

public int size()

Returns the number of intents in this selection group.

Returns:

number of intents

index

public int index()

Returns the index of the currently selected intent.

Returns:

the current index

intents

public List<org.onosproject.net.intent.Intent> intents()

The list of intents in this selection group.

Returns:

list of intents

next

public org.onosproject.net.intent.Intent next()

Marks and returns the next intent in this group. Note that the selection wraps around to the beginning again, if necessary.

Returns:

the next intent in the group

prev

public org.onosproject.net.intent.Intent prev()

Marks and returns the previous intent in this group. Note that the selection wraps around to the end again, if necessary.

Returns:

the previous intent in the group

current

public org.onosproject.net.intent.Intent current()

Returns the currently marked intent, or null if "all" intents are marked.

Returns:

the currently marked intent

toString

public String toString()

Overrides:

toString in class Object