Module org.bzdev.base

Package org.bzdev.io

Class DetabReader

java.lang.Object

java.io.Reader

org.bzdev.io.DetabReader

All Implemented Interfaces:

Closeable, AutoCloseable, Readable

public class DetabReader
extends Reader

Reader to remove tabs. The tab spacing is assumed to be 8 unless explicitly set in a constructor.

Formats such as YAML that use indentation to denote nesting do not allow tabs because the tab spacing cannot be predicted. While 8 is a common number, some editors can be configured to use a different value.

Field Summary

Fields inherited from class java.io.Reader

lock

Constructor Summary

Constructors

Constructor	Description
DetabReader(Reader r)	Constructor.
DetabReader(Reader r, int tabspacing)	Constructor with an explicit tab spacing.

Method Summary

Modifier and Type	Method	Description
void	close()
int	getTabSpacing()	Get the tab spacing.
int	read()
int	read(char[] cbuf, int off, int len)

Methods inherited from class java.io.Reader

mark, markSupported, nullReader, read, read, ready, reset, skip, transferTo

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

DetabReader

public DetabReader(Reader r)

Constructor.

Parameters:

r - a reader.

DetabReader

public DetabReader(Reader r,
 int tabspacing)
            throws IllegalArgumentException

Constructor with an explicit tab spacing.

Parameters:

r - a reader.

tabspacing - the tab spacing

Throws:

IllegalArgumentException - if the tab spacing is less than 1

Method Details

getTabSpacing

public int getTabSpacing()

Get the tab spacing.

Returns:

the tab spacing

read

public int read()
         throws IOException

Overrides:

read in class Reader

Throws:

IOException

read

public int read(char[] cbuf,
 int off,
 int len)
         throws IOException

Specified by:

read in class Reader

Throws:

IOException

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Specified by:

close in class Reader

Throws:

IOException