org.onosproject.net.config.basics

Class BasicRegionConfig

java.lang.Object

org.onosproject.net.config.Config<RegionId>

org.onosproject.net.config.basics.BasicRegionConfig

public final class BasicRegionConfig
extends Config<RegionId>

Basic configuration for network regions.

Nested Class Summary

Nested classes/interfaces inherited from class org.onosproject.net.config.Config

Config.FieldPresence

Field Summary

Fields inherited from class org.onosproject.net.config.Config

array, delegate, key, mapper, node, object, subject

Constructor Summary

Constructors

Constructor and Description
BasicRegionConfig()

Method Summary

Modifier and Type	Method and Description
List<DeviceId>	devices() Returns the identities of the devices in this region.
BasicRegionConfig	devices(Set<DeviceId> devices) Sets the devices of this region.
boolean	isValid() Indicates whether or not the backing JSON node contains valid data.
String	name() Returns the region name.
BasicRegionConfig	name(String name) Sets the name of this region.
String	toString()
Region.Type	type() Returns the region type.
BasicRegionConfig	type(Region.Type type) Sets the region type.

Methods inherited from class org.onosproject.net.config.Config

apply, clear, get, get, get, get, get, get, getList, getList, hasField, hasField, hasFields, hasFields, hasOnlyFields, hasOnlyFields, init, isBoolean, isBoolean, isConnectPoint, isConnectPoint, isDecimal, isDecimal, isIntegralNumber, isIntegralNumber, isIpAddress, isIpAddress, isIpPrefix, isIpPrefix, isMacAddress, isMacAddress, isNumber, isNumber, isString, isString, isTpPort, isTpPort, key, node, setOrClear, setOrClear, setOrClear, setOrClear, setOrClear, setOrClear, setOrClear, subject

Methods inherited from class java.lang.Object

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

Constructor Detail

BasicRegionConfig

public BasicRegionConfig()

Method Detail

isValid

public boolean isValid()

Description copied from class: Config

Indicates whether or not the backing JSON node contains valid data.

Default implementation returns true. Subclasses are expected to override this with their own validation. Implementations are free to throw a RuntimeException if data is invalid.

Overrides:

isValid in class Config<RegionId>

Returns:

true if the data is valid; false otherwise

toString

public String toString()

Overrides:

toString in class Object

name

public String name()

Returns the region name.

Returns:

the region name

name

public BasicRegionConfig name(String name)

Sets the name of this region.

Parameters:

name - name of region, or null to unset

Returns:

the config of the region

type

public Region.Type type()

Returns the region type.

Returns:

the region type

type

public BasicRegionConfig type(Region.Type type)

Sets the region type.

Parameters:

type - the region type, or null to unset

Returns:

the config of the region

devices

public List<DeviceId> devices()

Returns the identities of the devices in this region.

Returns:

list of device identifiers

devices

public BasicRegionConfig devices(Set<DeviceId> devices)

Sets the devices of this region.

Parameters:

devices - the device identifiers, or null to unset

Returns:

the config of the region