ParametersFromFileSupporter (adams-pom 26.7.0-SNAPSHOT API)

All Superinterfaces:

Destroyable, OptionHandler

All Known Implementing Classes:

AbstractDatabaseConnection, DatabaseConnection, IMAPConnection, SMBConnection, SMTPConnection, SSHConnection
```
public interface ParametersFromFileSupporter
extends OptionHandler
```
Interface for classes that can load some/all of their parameters from a properties file.

Author:

fracpete (fracpete at waikato dot ac dot nz)

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`PlaceholderFile`	`getParametersFile()`	Returns the properties file with the parameters to load.
`String`	`parametersFileTipText()`	Returns the tip text for this property.
`void`	`setParametersFile(PlaceholderFile value)`	Sets the properties file with the parameters to load.

Methods inherited from interface adams.core.Destroyable
destroy

Methods inherited from interface adams.core.option.OptionHandler
cleanUpOptions, defineOptions, getOptionManager, toCommandLine

- Method Detail
  - setParametersFile
```
void setParametersFile(PlaceholderFile value)
```
    Sets the properties file with the parameters to load. Ignored if pointing to a directory.
    
    Parameters:
    
    value - the file
  - getParametersFile
```
PlaceholderFile getParametersFile()
```
    Returns the properties file with the parameters to load. Ignored if pointing to a directory.
    
    Returns:
    
    the file
  - parametersFileTipText
```
String parametersFileTipText()
```
    Returns the tip text for this property.
    
    Returns:
    
    tip text for this property suitable for displaying in the GUI or for listing the options.