org.onosproject.mapping

Class DefaultMapping

java.lang.Object

org.onosproject.mapping.DefaultMapping

All Implemented Interfaces:

Mapping

Direct Known Subclasses:

DefaultMappingEntry

public class DefaultMapping
extends Object
implements Mapping

Default implementation class for mapping.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DefaultMapping.Builder Default mapping builder.

Constructor Summary

Constructors

Constructor and Description
DefaultMapping(org.onosproject.net.DeviceId deviceId, MappingKey key, MappingValue value, MappingId id) Creates a mapping specified with several parameters.
DefaultMapping(Mapping mapping) Creates a mapping specified with mapping information.

Method Summary

Modifier and Type	Method and Description
short	appId() Obtains the application identifier of this mapping.
static DefaultMapping.Builder	builder() Returns a default mapping builder.
org.onosproject.net.DeviceId	deviceId() Obtains the identity of the device where this mapping applies.
boolean	equals(Object obj)
int	hashCode()
MappingId	id() Obtains the identifier of this mapping.
MappingKey	key() Obtains the mapping key that is used for query the mapping entry.
String	toString()
MappingValue	value() Obtains the mapping value that is queried using the mapping key.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultMapping

public DefaultMapping(Mapping mapping)

Creates a mapping specified with mapping information.

Parameters:

mapping - mapping information

DefaultMapping

public DefaultMapping(org.onosproject.net.DeviceId deviceId,
                      MappingKey key,
                      MappingValue value,
                      MappingId id)

Creates a mapping specified with several parameters.

Parameters:

deviceId - device identifier

key - mapping key

value - mapping value

id - mapping identifier

Method Detail

id

public MappingId id()

Description copied from interface: Mapping

Obtains the identifier of this mapping.

Specified by:

id in interface Mapping

Returns:

mapping identifier

appId

public short appId()

Description copied from interface: Mapping

Obtains the application identifier of this mapping.

Specified by:

appId in interface Mapping

Returns:

an application identifier

deviceId

public org.onosproject.net.DeviceId deviceId()

Description copied from interface: Mapping

Obtains the identity of the device where this mapping applies.

Specified by:

deviceId in interface Mapping

Returns:

device identifier

key

public MappingKey key()

Description copied from interface: Mapping

Obtains the mapping key that is used for query the mapping entry.

Specified by:

key in interface Mapping

Returns:

mapping key

value

public MappingValue value()

Description copied from interface: Mapping

Obtains the mapping value that is queried using the mapping key.

Specified by:

value in interface Mapping

Returns:

mapping value

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Description copied from interface: Mapping

Equality for mappings only considers 'match equality'. This means that two mappings with the same match conditions will be equal.

Specified by:

equals in interface Mapping

Overrides:

equals in class Object

Parameters:

obj - the reference object with which to compare.

Returns:

true if this object is the same as the obj argument; false otherwise.

toString

public String toString()

Overrides:

toString in class Object

builder

public static DefaultMapping.Builder builder()

Returns a default mapping builder.

Returns:

builder