org.onosproject.net.config

Class Config<S>

java.lang.Object

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

Type Parameters:

S - type of subject

Direct Known Subclasses:

AllowedEntityConfig, OpticalPortConfig

@Beta
public abstract class Config<S>
extends Object

Base abstraction of a configuration facade for a specific subject. Derived classes should keep all state in the specified JSON tree as that is the only state that will be distributed or persisted; this class is merely a facade for interacting with a particular facet of configuration on a given subject.

Field Summary

Fields

Modifier and Type	Field and Description
protected com.fasterxml.jackson.databind.node.ArrayNode	array
protected ConfigApplyDelegate	delegate
protected String	key
protected com.fasterxml.jackson.databind.ObjectMapper	mapper
protected com.fasterxml.jackson.databind.JsonNode	node
protected com.fasterxml.jackson.databind.node.ObjectNode	object
protected S	subject

Constructor Summary

Constructors

Constructor and Description
Config()

Method Summary

Modifier and Type	Method and Description
void	apply() Applies any configuration changes made via this configuration.
protected boolean	get(String name, boolean defaultValue) Gets the specified property as a boolean.
protected double	get(String name, double defaultValue) Gets the specified property as a double.
protected <E extends Enum<E>> E	get(String name, E defaultValue, Class<E> enumClass) Gets the specified property as an enum.
protected int	get(String name, int defaultValue) Gets the specified property as an integer.
protected long	get(String name, long defaultValue) Gets the specified property as a long.
protected String	get(String name, String defaultValue) Gets the specified property as a string.
protected <T> List<T>	getList(String name, java.util.function.Function<String,T> function) Gets the specified array property as a list of items.
void	init(S subject, String key, com.fasterxml.jackson.databind.JsonNode node, com.fasterxml.jackson.databind.ObjectMapper mapper, ConfigApplyDelegate delegate) Initializes the configuration behaviour with necessary context.
String	key() Returns the configuration key.
com.fasterxml.jackson.databind.JsonNode	node() Returns the JSON node that contains the configuration data.
protected Config<S>	setOrClear(String name, Boolean value) Sets the specified property as a boolean or clears it if null value given.
protected <T> Config<S>	setOrClear(String name, Collection<T> collection) Sets the specified property as an array of items in a given collection or clears it if null is given.
protected Config<S>	setOrClear(String name, Double value) Sets the specified property as a double or clears it if null value given.
protected <E extends Enum> Config<S>	setOrClear(String name, E value) Sets the specified property as a double or clears it if null value given.
protected Config<S>	setOrClear(String name, Integer value) Sets the specified property as an integer or clears it if null value given.
protected Config<S>	setOrClear(String name, Long value) Sets the specified property as a long or clears it if null value given.
protected Config<S>	setOrClear(String name, String value) Sets the specified property as a string or clears it if null value given.
S	subject() Returns the specific subject to which this configuration pertains.

Methods inherited from class java.lang.Object

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

Field Detail

subject

protected S subject

key

protected String key

node

protected com.fasterxml.jackson.databind.JsonNode node

object

protected com.fasterxml.jackson.databind.node.ObjectNode object

array

protected com.fasterxml.jackson.databind.node.ArrayNode array

mapper

protected com.fasterxml.jackson.databind.ObjectMapper mapper

delegate

protected ConfigApplyDelegate delegate

Constructor Detail

Config

public Config()

Method Detail

init

public void init(S subject,
                 String key,
                 com.fasterxml.jackson.databind.JsonNode node,
                 com.fasterxml.jackson.databind.ObjectMapper mapper,
                 ConfigApplyDelegate delegate)

Initializes the configuration behaviour with necessary context.

Parameters:

subject - configuration subject

key - configuration key

node - JSON node where configuration data is stored

mapper - JSON object mapper

delegate - delegate context

subject

public S subject()

Returns the specific subject to which this configuration pertains.

Returns:

configuration subject

key

public String key()

Returns the configuration key. This is primarily aimed for use in composite JSON trees in external representations and has no bearing on the internal behaviours.

Returns:

configuration key

node

public com.fasterxml.jackson.databind.JsonNode node()

Returns the JSON node that contains the configuration data.

Returns:

JSON node backing the configuration

apply

public void apply()

Applies any configuration changes made via this configuration.

get

protected String get(String name,
                     String defaultValue)

Gets the specified property as a string.

Parameters:

name - property name

defaultValue - default value if property not set

Returns:

property value or default value

setOrClear

protected Config<S> setOrClear(String name,
                               String value)

Sets the specified property as a string or clears it if null value given.

Parameters:

name - property name

value - new value or null to clear the property

Returns:

self

get

protected boolean get(String name,
                      boolean defaultValue)

Gets the specified property as a boolean.

Parameters:

name - property name

defaultValue - default value if property not set

Returns:

property value or default value

setOrClear

protected Config<S> setOrClear(String name,
                               Boolean value)

Sets the specified property as a boolean or clears it if null value given.

Parameters:

name - property name

value - new value or null to clear the property

Returns:

self

get

protected int get(String name,
                  int defaultValue)

Gets the specified property as an integer.

Parameters:

name - property name

defaultValue - default value if property not set

Returns:

property value or default value

setOrClear

protected Config<S> setOrClear(String name,
                               Integer value)

Sets the specified property as an integer or clears it if null value given.

Parameters:

name - property name

value - new value or null to clear the property

Returns:

self

get

protected long get(String name,
                   long defaultValue)

Gets the specified property as a long.

Parameters:

name - property name

defaultValue - default value if property not set

Returns:

property value or default value

setOrClear

protected Config<S> setOrClear(String name,
                               Long value)

Sets the specified property as a long or clears it if null value given.

Parameters:

name - property name

value - new value or null to clear the property

Returns:

self

get

protected double get(String name,
                     double defaultValue)

Gets the specified property as a double.

Parameters:

name - property name

defaultValue - default value if property not set

Returns:

property value or default value

setOrClear

protected Config<S> setOrClear(String name,
                               Double value)

Sets the specified property as a double or clears it if null value given.

Parameters:

name - property name

value - new value or null to clear the property

Returns:

self

get

protected <E extends Enum<E>> E get(String name,
                                    E defaultValue,
                                    Class<E> enumClass)

Gets the specified property as an enum.

Type Parameters:

E - type of enum

Parameters:

name - property name

defaultValue - default value if property not set

enumClass - the enum class

Returns:

property value or default value

setOrClear

protected <E extends Enum> Config<S> setOrClear(String name,
                                                E value)

Sets the specified property as a double or clears it if null value given.

Type Parameters:

E - type of enum

Parameters:

name - property name

value - new value or null to clear the property

Returns:

self

getList

protected <T> List<T> getList(String name,
                              java.util.function.Function<String,T> function)

Gets the specified array property as a list of items.

Type Parameters:

T - type of item

Parameters:

name - property name

function - mapper from string to item

Returns:

list of items

setOrClear

protected <T> Config<S> setOrClear(String name,
                                   Collection<T> collection)

Sets the specified property as an array of items in a given collection or clears it if null is given.

Type Parameters:

T - type of items

Parameters:

name - propertyName

collection - collection of items

Returns:

self