com.hp.sdn.model

Class SegmentId

java.lang.Object

com.hp.sdn.model.SegmentId

All Implemented Interfaces:

Serializable, Comparable<SegmentId>

public class SegmentId
extends Object
implements Comparable<SegmentId>, Serializable

Identifier for a network segment. It is unique to the type of network to which it applies.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SegmentId.Type Network segment types.

Field Summary

Fields

Modifier and Type	Field and Description
static SegmentId	UNKNOWN A segment ID which represents an unknown segment

Method Summary

Methods

Modifier and Type	Method and Description
int	compareTo(SegmentId other)
boolean	equals(Object obj)
int	hashCode()
String	toString()
SegmentId.Type	type() Returns the type of network segment this identifies.
int	value() Returns the identifier as an integer value.
static SegmentId	valueOf(VlanId vlanId) Returns the given VLAN ID represented as a segment ID.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

UNKNOWN

public static final SegmentId UNKNOWN

A segment ID which represents an unknown segment

Method Detail

valueOf

public static SegmentId valueOf(VlanId vlanId)

Returns the given VLAN ID represented as a segment ID.

Parameters:

vlanId - VLAN ID

Returns:

segment ID representation

value

public int value()

Returns the identifier as an integer value.

Returns:

integer value

type

public SegmentId.Type type()

Returns the type of network segment this identifies.

Returns:

type of network segment

compareTo

public int compareTo(SegmentId other)

Specified by:

compareTo in interface Comparable<SegmentId>

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object