SimpleNodeConfigTransferObject (Dragom API 0.0.3 API)

java.lang.Object
- org.azyva.dragom.model.config.SimpleNodeConfigTransferObject

All Implemented Interfaces:

NodeConfigTransferObject
```
public class SimpleNodeConfigTransferObject
extends Object
implements NodeConfigTransferObject
```
Simple implementation for NodeConfigTransferObject.

Author:

David Raymond

Constructor Summary

Constructors
Constructor and Description

SimpleNodeConfigTransferObject()
Constructor.

Constructors
Constructor and Description
`SimpleNodeConfigTransferObject()` Constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`List<PluginDefConfig>`	`getListPluginDefConfig()` Returns a List of all the `PluginDefConfig`'s.
`List<PropertyDefConfig>`	`getListPropertyDefConfig()` Returns a List of all the `PropertyDefConfig`'s.
`String`	`getName()`
`PluginDefConfig`	`getPluginDefConfig(Class<? extends NodePlugin> classNodePlugin, String pluginId)` Returns a `PluginDefConfig`.
`PropertyDefConfig`	`getPropertyDefConfig(String name)` Returns a `PropertyDefConfig`.
`boolean`	`isPluginDefConfigExists(Class<? extends NodePlugin> classNodePlugin, String pluginId)` Verifies if a `PluginDefConfig` exists.
`boolean`	`isPropertyExists(String name)` Verifies if a `PropertyDefConfig` exists.
`void`	`removePlugingDefConfig(Class<? extends NodePlugin> classNodePlugin, String pluginId)` Removes a `PropertyDefConfig`.
`void`	`removePropertyDefConfig(String name)` Removes a `PropertyDefConfig`.
`void`	`setName(String name)` Sets the name.
`boolean`	`setPluginDefConfig(PluginDefConfig pluginDefConfig)` Sets a `PluginDefConfig`.
`boolean`	`setPropertyDefConfig(PropertyDefConfig propertyDefConfig)` Sets a `PropertyDefConfig`.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - SimpleNodeConfigTransferObject
```
public SimpleNodeConfigTransferObject()
```
    Constructor.
    This constructor is public since instances can be created by classes in different Dragom packages. Instances are meant to be created only by implementations of MutableConfig and child interfaces. We could enforce this by making the constructor protected and requiring specific subclasses with a package-scope constructor to be implemented for each implementation package, but for now, we keep it simple.
- Method Detail
  - getName
```
public String getName()
```
    Specified by:
    
    getName in interface NodeConfigTransferObject
    
    Returns:
    
    Name.
  - setName
```
public void setName(String name)
```
    Description copied from interface: NodeConfigTransferObject
    
    Sets the name.
    
    Specified by:
    
    setName in interface NodeConfigTransferObject
    
    Parameters:
    
    name - See description.
  - getPropertyDefConfig
```
public PropertyDefConfig getPropertyDefConfig(String name)
```
    Description copied from interface: NodeConfigTransferObject
    
    Returns a PropertyDefConfig.
    If the PropertyDefConfig exists but is defined with the value field set to null, a PropertyDefConfig is returned (instead of returning null).
    
    Specified by:
    
    getPropertyDefConfig in interface NodeConfigTransferObject
    
    Parameters:
    
    name - Name of the PropertyDefConfig.
    
    Returns:
    
    PropertyDefConfig. null if the PropertyDefConfig does not exist.
  - isPropertyExists
```
public boolean isPropertyExists(String name)
```
    Description copied from interface: NodeConfigTransferObject
    
    Verifies if a PropertyDefConfig exists.
    If the PropertyDefConfig exists but is defined with the value field set to null, true is returned.
    Returns true if an only if NodeConfigTransferObject.getPropertyDefConfig(java.lang.String) does not return null.
    
    Specified by:
    
    isPropertyExists in interface NodeConfigTransferObject
    
    Parameters:
    
    name - Name of the PropertyDefConfig.
    
    Returns:
    
    Indicates if the PropertyDefConfig exists.
  - getListPropertyDefConfig
```
public List<PropertyDefConfig> getListPropertyDefConfig()
```
    Description copied from interface: NodeConfigTransferObject
    
    Returns a List of all the PropertyDefConfig's.
    If no PropertyDefConfig is defined for the NodeConfig, an empty List is returned (as opposed to null).
    The order of the PropertyDefConfig is generally expected to be as defined in the underlying storage for the configuration, hence the List return type. But no particular order is actually guaranteed.
    
    Specified by:
    
    getListPropertyDefConfig in interface NodeConfigTransferObject
    
    Returns:
    
    See description.
  - removePropertyDefConfig
```
public void removePropertyDefConfig(String name)
```
    Description copied from interface: NodeConfigTransferObject
    
    Removes a PropertyDefConfig.
    
    Specified by:
    
    removePropertyDefConfig in interface NodeConfigTransferObject
    
    Parameters:
    
    name - Name of the PropertyDefConfig.
  - setPropertyDefConfig
```
public boolean setPropertyDefConfig(PropertyDefConfig propertyDefConfig)
```
    Description copied from interface: NodeConfigTransferObject
    
    Sets a PropertyDefConfig.
    If one already exists with the same name, it is overwritten. Otherwise it is added.
    Mostly any implementation of PropertyDefConfig can be used, although SimplePropertyDefConfig is generally the better choice.
    
    Specified by:
    
    setPropertyDefConfig in interface NodeConfigTransferObject
    
    Parameters:
    
    propertyDefConfig - PropertyDefConfig.
    
    Returns:
    
    Indicates if a new PropertyDefConfig was added (as opposed to an existing one having been overwritten.
  - getPluginDefConfig
```
public PluginDefConfig getPluginDefConfig(Class<? extends NodePlugin> classNodePlugin,
                                          String pluginId)
```
    Description copied from interface: NodeConfigTransferObject
    
    Returns a PluginDefConfig.
    If the PluginDefConfig exists but is defined with the pluginClass field set to null, a PluginDefConfig is returned (instead of returning null).
    
    Specified by:
    
    getPluginDefConfig in interface NodeConfigTransferObject
    
    Parameters:
    
    classNodePlugin - Class of the NodePlugin interface.
    
    pluginId - Plugin ID to distinguish between multiple instances of the same plugin. Can be null to get a PluginDefConfig whose field pluginId is null.
    
    Returns:
    
    PluginDefConfig. null if the PluginDefConfig does not exist.
  - isPluginDefConfigExists
```
public boolean isPluginDefConfigExists(Class<? extends NodePlugin> classNodePlugin,
                                       String pluginId)
```
    Description copied from interface: NodeConfigTransferObject
    
    Verifies if a PluginDefConfig exists.
    If the PluginDefConfig exists but is defined with the pluginClass field set to null, true is returned.
    Returns true if an only if NodeConfigTransferObject.getPluginDefConfig(java.lang.Class<? extends org.azyva.dragom.model.plugin.NodePlugin>, java.lang.String) does not return null.
    
    Specified by:
    
    isPluginDefConfigExists in interface NodeConfigTransferObject
    
    Parameters:
    
    classNodePlugin - Class of the NodePlugin interface.
    
    pluginId - Plugin ID to distinguish between multiple instances of the same plugin. Can be null to get a PluginDefConfig whose field pluginId is null.
    
    Returns:
    
    Indicates if the PluginDefConfig exists.
  - getListPluginDefConfig
```
public List<PluginDefConfig> getListPluginDefConfig()
```
    Description copied from interface: NodeConfigTransferObject
    
    Returns a List of all the PluginDefConfig's.
    If no PluginDefConfig is defined for the NodeConfig, an empty Set is returned (as opposed to null).
    The order of the PluginDefConfig is generally expected to be as defined in the underlying storage for the configuration, hence the List return type. But no particular order is actually guaranteed.
    
    Specified by:
    
    getListPluginDefConfig in interface NodeConfigTransferObject
    
    Returns:
    
    See description.
  - removePlugingDefConfig
```
public void removePlugingDefConfig(Class<? extends NodePlugin> classNodePlugin,
                                   String pluginId)
```
    Description copied from interface: NodeConfigTransferObject
    
    Removes a PropertyDefConfig.
    
    Specified by:
    
    removePlugingDefConfig in interface NodeConfigTransferObject
    
    Parameters:
    
    classNodePlugin - Class of the NodePlugin interface.
    
    pluginId - Plugin ID to distinguish between multiple instances of the same plugin. Can be null to get a PluginDefConfig whose field pluginId is null.
  - setPluginDefConfig
```
public boolean setPluginDefConfig(PluginDefConfig pluginDefConfig)
```
    Description copied from interface: NodeConfigTransferObject
    
    Sets a PluginDefConfig.
    If one already exists with the same PluginKey, it is overwritten. Otherwise it is added.
    Mostly any implementation of PluginDefConfig can be used, although SimplePluginDefConfig is generally the better choice.
    
    Specified by:
    
    setPluginDefConfig in interface NodeConfigTransferObject
    
    Parameters:
    
    pluginDefConfig - PluginDefConfig.
    
    Returns:
    
    Indicates if a new PluginDefConfig was added (as opposed to an existing one having been overwritten.

Class SimpleNodeConfigTransferObject

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

SimpleNodeConfigTransferObject

Method Detail

getName

setName

getPropertyDefConfig

isPropertyExists

getListPropertyDefConfig

removePropertyDefConfig

setPropertyDefConfig

getPluginDefConfig

isPluginDefConfigExists

getListPluginDefConfig

removePlugingDefConfig

setPluginDefConfig