DeviceInjectionConfig (ONOS Java API (2.5.0))

java.lang.Object
- org.onosproject.net.config.Config<S>
- - org.onosproject.net.config.BaseConfig<DeviceId>
  - - org.onosproject.net.config.inject.DeviceInjectionConfig

All Implemented Interfaces:: CodecContext

@Beta
public class DeviceInjectionConfig
extends BaseConfig<DeviceId>

Config to inject a Device.

Nested Class Summary
- Nested classes/interfaces inherited from class org.onosproject.net.config.Config
  Config.FieldPresence

Field Summary

Fields
Modifier and Type Field Description

static String CONFIG_KEY
Configuration key for DeviceInjectionConfig.
- Fields inherited from class org.onosproject.net.config.Config
  array, delegate, key, mapper, node, object, subject

Constructor Summary

Constructors
Constructor Description

DeviceInjectionConfig()
Create a DeviceInjectionConfig.

DeviceInjectionConfig(DeviceId did)
Create a DeviceInjectionConfig for specified Device.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`boolean`	`isValid()`	Indicates whether or not the backing JSON node contains valid data.
`String`	`ports()`
`String`	`toString()`

Methods inherited from class org.onosproject.net.config.BaseConfig
codec, decode, getService, mapper

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, isValidLength, key, node, setList, 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

Methods inherited from interface org.onosproject.codec.CodecContext
decode, encode

- Field Detail
  - CONFIG_KEY
```
public static final String CONFIG_KEY
```
    Configuration key for DeviceInjectionConfig.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - DeviceInjectionConfig
```
public DeviceInjectionConfig()
```
    Create a DeviceInjectionConfig.
    Note: created instance needs to be initialized by #init(..) before using.
  - DeviceInjectionConfig
```
public DeviceInjectionConfig(DeviceId did)
```
    Create a DeviceInjectionConfig for specified Device.
    Note: created instance is not bound to NetworkConfigService, cannot use Config.apply(). Must be passed to the service using NetworkConfigService#applyConfig
    
    Parameters:
    
    did - DeviceId
- 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<DeviceId>
    
    Returns:
    
    true if the data is valid; false otherwise
  - ports
```
public String ports()
```
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Config<DeviceId>