org.onosproject.mapping

Interface Mapping

All Known Subinterfaces:

MappingEntry, StoredMappingEntry

All Known Implementing Classes:

DefaultMapping, DefaultMappingEntry

public interface Mapping

Abstraction of mapping.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	Mapping.Builder A mapping builder.

Method Summary

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

Method Detail

id

MappingId id()

Obtains the identifier of this mapping.

Returns:

mapping identifier

appId

short appId()

Obtains the application identifier of this mapping.

Returns:

an application identifier

deviceId

org.onosproject.net.DeviceId deviceId()

Obtains the identity of the device where this mapping applies.

Returns:

device identifier

key

MappingKey key()

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

Returns:

mapping key

value

MappingValue value()

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

Returns:

mapping value

equals

boolean equals(Object obj)

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

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.