DatabaseConnectionDefinition (adams-pom 24.5.0-SNAPSHOT API)

java.lang.Object
- adams.env.AbstractPropertiesDefinition
- - adams.env.DatabaseConnectionDefinition

All Implemented Interfaces:

Serializable
```
public class DatabaseConnectionDefinition
extends AbstractPropertiesDefinition
```
Definition for the DatabaseConnection props file.

Version:

$Revision$

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type Field Description

static String KEY
the key as constant.

Constructor Summary

Constructors
Constructor Description

DatabaseConnectionDefinition()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`String`	`getAlternativeExtension()`	Returns an alternative extension to use besides the default one ("props").
`String`	`getFile()`	Returns the properties file name (no path) this definition is for.
`String`	`getKey()`	Returns the key this definition is for.
`void`	`update(AbstractEnvironment env)`	Updates the environment object with its definition for the props file (whether to add/replace/etc the values).

Methods inherited from class adams.env.AbstractPropertiesDefinition
add, add, add, createPath, createPath, hasAlternativeExtension, replace, replace, toString

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

- Field Detail
  - KEY
```
public static final String KEY
```
    the key as constant.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - DatabaseConnectionDefinition
```
public DatabaseConnectionDefinition()
```
- Method Detail
  - getKey
```
public String getKey()
```
    Returns the key this definition is for.
    
    Specified by:
    
    getKey in class AbstractPropertiesDefinition
    
    Returns:
    
    the key
  - getFile
```
public String getFile()
```
    Returns the properties file name (no path) this definition is for.
    
    Specified by:
    
    getFile in class AbstractPropertiesDefinition
    
    Returns:
    
    the key
  - getAlternativeExtension
```
public String getAlternativeExtension()
```
    Returns an alternative extension to use besides the default one ("props"). Useful if distinguishing props files from different projects.
    
    Overrides:
    
    getAlternativeExtension in class AbstractPropertiesDefinition
    
    Returns:
    
    the alternative extension (without dot), null if none available
  - update
```
public void update(AbstractEnvironment env)
```
    Updates the environment object with its definition for the props file (whether to add/replace/etc the values).
    
    Specified by:
    
    update in class AbstractPropertiesDefinition
    
    Parameters:
    
    env - the environment object to update