org.onosproject.net.config.basics

Class BasicElementConfig<S>

java.lang.Object

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

org.onosproject.net.config.basics.AllowedEntityConfig<S>

org.onosproject.net.config.basics.BasicElementConfig<S>

Direct Known Subclasses:

BasicDeviceConfig, BasicHostConfig

public abstract class BasicElementConfig<S>
extends AllowedEntityConfig<S>

Basic configuration for network elements, e.g. devices, hosts. Such elements can have a friendly name, geo-coordinates, logical rack coordinates and an owner entity.

Field Summary

Fields

Modifier and Type	Field and Description
protected static double	DEFAULT_COORD
static String	LATITUDE
static String	LONGITUDE
static String	NAME
static String	OWNER
static String	RACK_ADDRESS

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

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

Constructor Summary

Constructors

Constructor and Description
BasicElementConfig()

Method Summary

Modifier and Type	Method and Description
double	latitude() Returns element latitude.
BasicElementConfig	latitude(Double latitude) Sets the element latitude.
double	longitude() Returns element latitude.
BasicElementConfig	longitude(Double longitude) Sets the element longitude.
String	name() Returns friendly label for the element.
BasicElementConfig	name(String name) Sets friendly label for the element.
String	owner() Returns owner of the element.
BasicElementConfig	owner(String owner) Sets the owner of the element.
String	rackAddress() Returns the element rack address.
BasicElementConfig	rackAddress(String address) Sets element rack address.

Methods inherited from class org.onosproject.net.config.basics.AllowedEntityConfig

isAllowed, isAllowed

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

apply, get, get, get, get, get, get, getList, init, key, node, setOrClear, setOrClear, setOrClear, setOrClear, setOrClear, setOrClear, setOrClear, subject

Methods inherited from class java.lang.Object

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

Field Detail

NAME

public static final String NAME

See Also:

Constant Field Values

LATITUDE

public static final String LATITUDE

See Also:

Constant Field Values

LONGITUDE

public static final String LONGITUDE

See Also:

Constant Field Values

RACK_ADDRESS

public static final String RACK_ADDRESS

See Also:

Constant Field Values

OWNER

public static final String OWNER

See Also:

Constant Field Values

DEFAULT_COORD

protected static final double DEFAULT_COORD

See Also:

Constant Field Values

Constructor Detail

BasicElementConfig

public BasicElementConfig()

Method Detail

name

public String name()

Returns friendly label for the element.

Returns:

friendly label or element id itself if not set

name

public BasicElementConfig name(String name)

Sets friendly label for the element.

Parameters:

name - new friendly label; null to clear

Returns:

self

latitude

public double latitude()

Returns element latitude.

Returns:

element latitude; -1 if not set

latitude

public BasicElementConfig latitude(Double latitude)

Sets the element latitude.

Parameters:

latitude - new latitude; null to clear

Returns:

self

longitude

public double longitude()

Returns element latitude.

Returns:

element latitude; -1 if not set

longitude

public BasicElementConfig longitude(Double longitude)

Sets the element longitude.

Parameters:

longitude - new longitude; null to clear

Returns:

self

rackAddress

public String rackAddress()

Returns the element rack address.

Returns:

rack address; null if not set

rackAddress

public BasicElementConfig rackAddress(String address)

Sets element rack address.

Parameters:

address - new rack address; null to clear

Returns:

self

owner

public String owner()

Returns owner of the element.

Returns:

owner or null if not set

owner

public BasicElementConfig owner(String owner)

Sets the owner of the element.

Parameters:

owner - new owner; null to clear

Returns:

self