AbstractFilenameGeneratorWithDirectory (adams-pom 24.5.0-SNAPSHOT API)

java.lang.Object
- adams.core.logging.LoggingObject
- - adams.core.logging.CustomLoggingLevelObject
  - - adams.core.option.AbstractOptionHandler
    - - adams.core.io.AbstractFilenameGenerator
      - adams.core.io.AbstractFilenameGeneratorWithDirectory

All Implemented Interfaces:

Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, QuickInfoSupporter, SizeOfHandler, Serializable

Direct Known Subclasses:

AbstractFilenameGeneratorWithExtension, FixedFilenameGenerator
```
public abstract class AbstractFilenameGeneratorWithDirectory
extends AbstractFilenameGenerator
```
Ancestor for filename generators that use a directory.

Version:

$Revision$

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type Field Description

protected PlaceholderDirectory m_Directory
the parent directory of the file.
- Fields inherited from class adams.core.option.AbstractOptionHandler
  m_OptionManager
- Fields inherited from class adams.core.logging.LoggingObject
  m_Logger, m_LoggingIsEnabled, m_LoggingLevel

Constructor Summary

Constructors
Constructor Description

AbstractFilenameGeneratorWithDirectory()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`defineOptions()`	Adds options to the internal list of options.
`String`	`directoryTipText()`	Returns the tip text for this property.
`PlaceholderDirectory`	`getDirectory()`	Returns the parent directory for the generated filename.
`void`	`setDirectory(PlaceholderDirectory value)`	Sets the parent directory for the generated filename.

Methods inherited from class adams.core.io.AbstractFilenameGenerator
canHandleNullObject, check, doGenerate, generate, getQuickInfo

Methods inherited from class adams.core.option.AbstractOptionHandler
cleanUpOptions, destroy, finishInit, getDefaultLoggingLevel, getOptionManager, globalInfo, initialize, loggingLevelTipText, newOptionManager, reset, setLoggingLevel, toCommandLine, toString

Methods inherited from class adams.core.logging.LoggingObject
configureLogger, getLogger, getLoggingLevel, initializeLogging, isLoggingEnabled, sizeOf

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

Methods inherited from interface adams.core.logging.LoggingLevelHandler
getLoggingLevel

- Field Detail
  - m_Directory
```
protected PlaceholderDirectory m_Directory
```
    the parent directory of the file.
- Constructor Detail
  - AbstractFilenameGeneratorWithDirectory
```
public AbstractFilenameGeneratorWithDirectory()
```
- Method Detail
  - defineOptions
```
public void defineOptions()
```
    Adds options to the internal list of options.
    
    Specified by:
    
    defineOptions in interface OptionHandler
    
    Overrides:
    
    defineOptions in class AbstractOptionHandler
  - setDirectory
```
public void setDirectory(PlaceholderDirectory value)
```
    Sets the parent directory for the generated filename.
    
    Parameters:
    
    value - the directory
  - getDirectory
```
public PlaceholderDirectory getDirectory()
```
    Returns the parent directory for the generated filename.
    
    Returns:
    
    the directory
  - directoryTipText
```
public String directoryTipText()
```
    Returns the tip text for this property.
    
    Returns:
    
    tip text for this property suitable for displaying in the GUI or for listing the options.