org.onosproject.net.device

Class DefaultPortDescription

java.lang.Object

org.onosproject.net.AbstractDescription

org.onosproject.net.device.DefaultPortDescription

All Implemented Interfaces:

Annotated, Description, PortDescription

public class DefaultPortDescription
extends AbstractDescription
implements PortDescription

Default implementation of immutable port description.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DefaultPortDescription.Builder

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	DefaultPortDescription()
	DefaultPortDescription(PortDescription base, SparseAnnotations annotations) Creates a port description using the supplied information.
	DefaultPortDescription(PortNumber number, boolean isEnabled, boolean isRemoved, Port.Type type, long portSpeed, SparseAnnotations... annotations) Creates a port description using the supplied information.
	DefaultPortDescription(PortNumber number, boolean isEnabled, Port.Type type, long portSpeed, SparseAnnotations... annotations) Creates a port description using the supplied information.
	DefaultPortDescription(PortNumber number, boolean isEnabled, SparseAnnotations... annotations) Creates a DEFAULT_SPEED COPPER port description using the supplied information.

Method Summary

Modifier and Type	Method and Description
static DefaultPortDescription.Builder	builder() Creates port description builder with default parameters.
static DefaultPortDescription.Builder	builder(PortDescription desc) Creates port description builder inheriting with default parameters, from specified port description.
static DefaultPortDescription	copyReplacingAnnotation(PortDescription base, SparseAnnotations annotations) Creates a port description using the supplied information.
boolean	equals(java.lang.Object object)
int	hashCode()
boolean	isEnabled() Indicates whether or not the port is up and active.
boolean	isRemoved() Indicates whether or not the port was removed.
PortNumber	portNumber() Returns the port number.
long	portSpeed() Returns the current port speed in Mbps.
java.lang.String	toString()
Port.Type	type() Returns the port type.

Methods inherited from class org.onosproject.net.AbstractDescription

annotations

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.onosproject.net.Description

annotations

Constructor Detail

DefaultPortDescription

public DefaultPortDescription(PortNumber number,
                              boolean isEnabled,
                              SparseAnnotations... annotations)

Creates a DEFAULT_SPEED COPPER port description using the supplied information.

Parameters:

number - port number

isEnabled - port enabled state

annotations - optional key/value annotations map

DefaultPortDescription

public DefaultPortDescription(PortNumber number,
                              boolean isEnabled,
                              Port.Type type,
                              long portSpeed,
                              SparseAnnotations... annotations)

Creates a port description using the supplied information.

Parameters:

number - port number

isEnabled - port enabled state

type - port type

portSpeed - port speed in Mbps

annotations - optional key/value annotations map

DefaultPortDescription

public DefaultPortDescription(PortNumber number,
                              boolean isEnabled,
                              boolean isRemoved,
                              Port.Type type,
                              long portSpeed,
                              SparseAnnotations... annotations)

Creates a port description using the supplied information.

Parameters:

number - port number

isEnabled - port enabled state

isRemoved - port removed state

type - port type

portSpeed - port speed in Mbps

annotations - optional key/value annotations map

DefaultPortDescription

protected DefaultPortDescription()

DefaultPortDescription

public DefaultPortDescription(PortDescription base,
                              SparseAnnotations annotations)

Creates a port description using the supplied information.

Parameters:

base - PortDescription to get basic information from

annotations - optional key/value annotations map

Method Detail

copyReplacingAnnotation

public static DefaultPortDescription copyReplacingAnnotation(PortDescription base,
                                                             SparseAnnotations annotations)

Creates a port description using the supplied information.

Parameters:

base - port description to copy fields from

annotations - to be used in the copied description. Note: Annotations on base will be ignored.

Returns:

copied port description

portNumber

public PortNumber portNumber()

Description copied from interface: PortDescription

Returns the port number.

Specified by:

portNumber in interface PortDescription

Returns:

port number

isEnabled

public boolean isEnabled()

Description copied from interface: PortDescription

Indicates whether or not the port is up and active.

Specified by:

isEnabled in interface PortDescription

Returns:

true if the port is active and has carrier signal

isRemoved

public boolean isRemoved()

Description copied from interface: PortDescription

Indicates whether or not the port was removed.

Specified by:

isRemoved in interface PortDescription

Returns:

true if the port is removed.

type

public Port.Type type()

Description copied from interface: PortDescription

Returns the port type.

Specified by:

type in interface PortDescription

Returns:

port type

portSpeed

public long portSpeed()

Description copied from interface: PortDescription

Returns the current port speed in Mbps.

Specified by:

portSpeed in interface PortDescription

Returns:

current port speed

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractDescription

equals

public boolean equals(java.lang.Object object)

Overrides:

equals in class AbstractDescription

builder

public static DefaultPortDescription.Builder builder()

Creates port description builder with default parameters.

Returns:

builder

builder

public static DefaultPortDescription.Builder builder(PortDescription desc)

Creates port description builder inheriting with default parameters, from specified port description.

Parameters:

desc - to inherit default from

Returns:

builder