NodeConfigTransferObject (Dragom API 0.1.2 API)

```
public interface NodeConfigTransferObject
```
Transfer object for a MutableNodeConfig basic configuration data.
MutableNodeConfig and its sub-interfaces return and take as argument this interface to allow getting and setting atomically data. See MutableConfig.
It so happens that the only configuration data that can be transfered from and to MutableNodeConfig's (and its sub-interfaces) are the same and are represented by this interface. If MutableNodeConfig and its sub-interfaces eventually contain other configuration data that are not common, the orientation will probably be to introduce new transfer objects instead implementing an interface hierarchy to factor out commonality.
Since this interface represents a transfer object, implementations are generally straightforward, and in most cases, SimpleNodeConfigTransferObject will be adequate. Specifically if an implementation of MutableNodeConfig needs to manage concurrency with optimistic locking, OptimisticLockHandle should be used instead of including some hidden field within the NodeConfigTransferObject implementation.

Author:

David Raymond

Method Summary

All Methods Instance Methods Abstract 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`.

- Method Detail
  - getName
```
String getName()
```
    Returns:
    
    Name.
  - setName
```
void setName(String name)
```
    Sets the name.
    
    Parameters:
    
    name - See description.
  - getPropertyDefConfig
```
PropertyDefConfig getPropertyDefConfig(String name)
```
    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).
    
    Parameters:
    
    name - Name of the PropertyDefConfig.
    
    Returns:
    
    PropertyDefConfig. null if the PropertyDefConfig does not exist.
  - isPropertyExists
```
boolean isPropertyExists(String name)
```
    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 getPropertyDefConfig(java.lang.String) does not return null.
    
    Parameters:
    
    name - Name of the PropertyDefConfig.
    
    Returns:
    
    Indicates if the PropertyDefConfig exists.
  - getListPropertyDefConfig
```
List<PropertyDefConfig> getListPropertyDefConfig()
```
    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.
    
    Returns:
    
    See description.
  - removePropertyDefConfig
```
void removePropertyDefConfig(String name)
```
    Removes a PropertyDefConfig.
    
    Parameters:
    
    name - Name of the PropertyDefConfig.
  - setPropertyDefConfig
```
boolean setPropertyDefConfig(PropertyDefConfig propertyDefConfig)
```
    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.
    
    Parameters:
    
    propertyDefConfig - PropertyDefConfig.
    
    Returns:
    
    Indicates if a new PropertyDefConfig was added (as opposed to an existing one having been overwritten.
  - getPluginDefConfig
```
PluginDefConfig getPluginDefConfig(Class<? extends NodePlugin> classNodePlugin,
                                   String pluginId)
```
    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).
    
    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
```
boolean isPluginDefConfigExists(Class<? extends NodePlugin> classNodePlugin,
                                String pluginId)
```
    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 getPluginDefConfig(java.lang.Class<? extends org.azyva.dragom.model.plugin.NodePlugin>, java.lang.String) does not return null.
    
    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
```
List<PluginDefConfig> getListPluginDefConfig()
```
    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.
    
    Returns:
    
    See description.
  - removePlugingDefConfig
```
void removePlugingDefConfig(Class<? extends NodePlugin> classNodePlugin,
                            String pluginId)
```
    Removes a PropertyDefConfig.
    
    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
```
boolean setPluginDefConfig(PluginDefConfig pluginDefConfig)
```
    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.
    
    Parameters:
    
    pluginDefConfig - PluginDefConfig.
    
    Returns:
    
    Indicates if a new PluginDefConfig was added (as opposed to an existing one having been overwritten.

Interface NodeConfigTransferObject

Method Summary

Method Detail

getName

setName

getPropertyDefConfig

isPropertyExists

getListPropertyDefConfig

removePropertyDefConfig

setPropertyDefConfig

getPluginDefConfig

isPluginDefConfigExists

getListPluginDefConfig

removePlugingDefConfig

setPluginDefConfig