org.onosproject.mapping

Class DefaultMapping.Builder

java.lang.Object

org.onosproject.mapping.DefaultMapping.Builder

All Implemented Interfaces:

Mapping.Builder

Enclosing class:

DefaultMapping

public static final class DefaultMapping.Builder
extends Object
implements Mapping.Builder

Default mapping builder.

Constructor Summary

Constructors

Constructor and Description
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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Builder

public Builder()

Method Detail

withId

public Mapping.Builder withId(long id)

Description copied from interface: Mapping.Builder

Assigns an id value to this mapping.

Specified by:

withId in interface Mapping.Builder

Parameters:

id - a long value

Returns:

this builder object

fromApp

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

Description copied from interface: Mapping.Builder

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.

Specified by:

fromApp in interface Mapping.Builder

Parameters:

appId - an application identifier

Returns:

this builder object

forDevice

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

Description copied from interface: Mapping.Builder

Sets the deviceId for this mapping.

Specified by:

forDevice in interface Mapping.Builder

Parameters:

deviceId - a device identifier

Returns:

this builder object

withKey

public Mapping.Builder withKey(MappingKey key)

Description copied from interface: Mapping.Builder

Sets the mapping key for this mapping.

Specified by:

withKey in interface Mapping.Builder

Parameters:

key - mapping key

Returns:

this builder object

withValue

public Mapping.Builder withValue(MappingValue value)

Description copied from interface: Mapping.Builder

Sets the mapping value for this mapping.

Specified by:

withValue in interface Mapping.Builder

Parameters:

value - mapping value

Returns:

this builder object

build

public Mapping build()

Description copied from interface: Mapping.Builder

Builds a mapping object.

Specified by:

build in interface Mapping.Builder

Returns:

a mapping object