AbstractFilenameGeneratorWithExtension (adams-pom 24.12.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
        
        adams.core.io.AbstractFilenameGeneratorWithExtension

All Implemented Interfaces:

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

Direct Known Subclasses:

DefaultFilenameGenerator, SimpleFilenameGenerator
```
public abstract class AbstractFilenameGeneratorWithExtension
extends AbstractFilenameGeneratorWithDirectory
```
Ancestor for filename generators that require a provided extension.

Version:

$Revision$

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type Field Description

protected String m_Extension
the extension to use.
- Fields inherited from class adams.core.io.AbstractFilenameGeneratorWithDirectory
  m_Directory
- 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

AbstractFilenameGeneratorWithExtension()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`defineOptions()`	Adds options to the internal list of options.
`String`	`extensionTipText()`	Returns the tip text for this property.
`String`	`getExtension()`	Returns the extension in use.
`void`	`setExtension(String value)`	Sets the extension to use.

Methods inherited from class adams.core.io.AbstractFilenameGeneratorWithDirectory
directoryTipText, getDirectory, setDirectory

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_Extension
```
protected String m_Extension
```
    the extension to use.
- Constructor Detail
  - AbstractFilenameGeneratorWithExtension
```
public AbstractFilenameGeneratorWithExtension()
```
- Method Detail
  - defineOptions
```
public void defineOptions()
```
    Adds options to the internal list of options.
    
    Specified by:
    
    defineOptions in interface OptionHandler
    
    Overrides:
    
    defineOptions in class AbstractFilenameGeneratorWithDirectory
  - setExtension
```
public void setExtension(String value)
```
    Sets the extension to use.
    
    Parameters:
    
    value - the extension (incl dot)
  - getExtension
```
public String getExtension()
```
    Returns the extension in use.
    
    Returns:
    
    the extension (incl dot)
  - extensionTipText
```
public String extensionTipText()
```
    Returns the tip text for this property.
    
    Returns:
    
    tip text for this property suitable for displaying in the GUI or for listing the options.