AbstractTextReaderWithEncoding (adams-pom 24.5.0-SNAPSHOT API)

java.lang.Object
- adams.core.logging.LoggingObject
- - adams.core.logging.CustomLoggingLevelObject
  - - adams.core.option.AbstractOptionHandler
    - - adams.data.io.input.AbstractTextReader<T>
      - adams.data.io.input.AbstractTextReaderWithEncoding<T>

Type Parameters:

T - the type of data generated

All Implemented Interfaces:

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

Direct Known Subclasses:

LineArrayTextReader, LineByLineTextReader, SingleStringTextReader
```
public abstract class AbstractTextReaderWithEncoding<T>
extends AbstractTextReader<T>
```
Ancestor for text readers that support file encodings.

Version:

$Revision$

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type Field Description

protected BaseCharset m_Encoding
the encoding to use.
- Fields inherited from class adams.data.io.input.AbstractTextReader
  m_Stream
- 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

AbstractTextReaderWithEncoding()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`defineOptions()`	Adds options to the internal list of options.
`String`	`encodingTipText()`	Returns the tip text for this property.
`BaseCharset`	`getEncoding()`	Returns the encoding to use.
`String`	`getQuickInfo()`	Returns a quick info about the actor, which will be displayed in the GUI.
`void`	`setEncoding(BaseCharset value)`	Sets the encoding to use.

Methods inherited from class adams.data.io.input.AbstractTextReader
doNext, generates, hasNext, initialize, next, reset

Methods inherited from class adams.core.option.AbstractOptionHandler
cleanUpOptions, destroy, finishInit, getDefaultLoggingLevel, getOptionManager, globalInfo, initialize, loggingLevelTipText, newOptionManager, 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_Encoding
```
protected BaseCharset m_Encoding
```
    the encoding to use.
- Constructor Detail
  - AbstractTextReaderWithEncoding
```
public AbstractTextReaderWithEncoding()
```
- 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
  - setEncoding
```
public void setEncoding(BaseCharset value)
```
    Sets the encoding to use.
    
    Parameters:
    
    value - the encoding, e.g. "UTF-8" or "UTF-16", empty string for default
  - getEncoding
```
public BaseCharset getEncoding()
```
    Returns the encoding to use.
    
    Returns:
    
    the encoding, e.g. "UTF-8" or "UTF-16", empty string for default
  - encodingTipText
```
public String encodingTipText()
```
    Returns the tip text for this property.
    
    Returns:
    
    tip text for this property suitable for displaying in the GUI or for listing the options.
  - getQuickInfo
```
public String getQuickInfo()
```
    Returns a quick info about the actor, which will be displayed in the GUI.
    
    Specified by:
    
    getQuickInfo in interface QuickInfoSupporter
    
    Overrides:
    
    getQuickInfo in class AbstractTextReader<T>
    
    Returns:
    
    null if no info available, otherwise short string