org.onosproject.mapping

Interface Mapping.Builder

All Known Implementing Classes:

DefaultMapping.Builder

Enclosing interface:

Mapping

public static interface Mapping.Builder

A mapping builder.

Method Summary

Modifier and Type	Method and Description
Mapping	build() Builds a mapping object.
Mapping.Builder	forDevice(org.onosproject.net.DeviceId deviceId) Sets the deviceId for this mapping.
Mapping.Builder	fromApp(org.onosproject.core.ApplicationId appId) Assigns the application that built this mapping to this object.
Mapping.Builder	withId(long id) Assigns an id value to this mapping.
Mapping.Builder	withKey(MappingKey key) Sets the mapping key for this mapping.
Mapping.Builder	withValue(MappingValue value) Sets the mapping value for this mapping.

Method Detail

withId

Mapping.Builder withId(long id)

Assigns an id value to this mapping.

Parameters:

id - a long value

Returns:

this builder object

fromApp

Mapping.Builder fromApp(org.onosproject.core.ApplicationId appId)

Assigns the application that built this mapping to this object. The short value of the appId will be used as a basis for the cookie value computation. It is expected that application use this call to set their application id.

Parameters:

appId - an application identifier

Returns:

this builder object

forDevice

Mapping.Builder forDevice(org.onosproject.net.DeviceId deviceId)

Sets the deviceId for this mapping.

Parameters:

deviceId - a device identifier

Returns:

this builder object

withKey

Mapping.Builder withKey(MappingKey key)

Sets the mapping key for this mapping.

Parameters:

key - mapping key

Returns:

this builder object

withValue

Mapping.Builder withValue(MappingValue value)

Sets the mapping value for this mapping.

Parameters:

value - mapping value

Returns:

this builder object

build

Mapping build()

Builds a mapping object.

Returns:

a mapping object