org.apache.tools.ant.filters
Class TabsToSpaces

java.lang.Object
  |
  +--java.io.Reader
        |
        +--java.io.FilterReader
              |
              +--org.apache.tools.ant.filters.BaseFilterReader
                    |
                    +--org.apache.tools.ant.filters.BaseParamFilterReader
                          |
                          +--org.apache.tools.ant.filters.TabsToSpaces

All Implemented Interfaces:

ChainableReader, Parameterizable

public final class TabsToSpaces

extends BaseParamFilterReader

implements ChainableReader

Converts tabs to spaces. Example:

<tabtospaces tablength="8"/>

Or:

<filterreader classname="org.apache.tools.ant.filters.TabsToSpaces">
   <param name="tablength" value="8"/>
 </filterreader>

Field Summary

Fields inherited from class java.io.FilterReader

in

Fields inherited from class java.io.Reader

lock

Constructor Summary

TabsToSpaces()
Constructor for "dummy" instances.

TabsToSpaces(java.io.Reader in)
Creates a new filtered reader.

Method Summary

java.io.Reader	chain(java.io.Reader rdr) Creates a new TabsToSpaces using the passed in Reader for instantiation.
int	read() Returns the next character in the filtered stream, converting tabs to the specified number of spaces.
void	setTablength(int tabLength) Sets the tab length.

Methods inherited from class org.apache.tools.ant.filters.BaseParamFilterReader

getParameters, setParameters

Methods inherited from class org.apache.tools.ant.filters.BaseFilterReader

getInitialized, getProject, read, readFully, readLine, setInitialized, setProject, skip

Methods inherited from class java.io.FilterReader

close, mark, markSupported, ready, reset

Methods inherited from class java.io.Reader

read

Methods inherited from class java.lang.Object

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

Constructor Detail

TabsToSpaces

public TabsToSpaces()

Constructor for "dummy" instances.

See Also:

BaseFilterReader.BaseFilterReader()

TabsToSpaces

public TabsToSpaces(java.io.Reader in)

Creates a new filtered reader.

Parameters:

in - A Reader object providing the underlying stream. Must not be null.

Method Detail

read

public final int read()
               throws java.io.IOException

Returns the next character in the filtered stream, converting tabs to the specified number of spaces.

Overrides:

read in class java.io.FilterReader

Returns:

the next character in the resulting stream, or -1 if the end of the resulting stream has been reached

Throws:

java.io.IOException - if the underlying stream throws an IOException during reading

setTablength

public final void setTablength(int tabLength)

Sets the tab length.

Parameters:

tabLength - the number of spaces to be used when converting a tab.

chain

public final java.io.Reader chain(java.io.Reader rdr)

Creates a new TabsToSpaces using the passed in Reader for instantiation.

Specified by:

chain in interface ChainableReader

Parameters:

rdr - A Reader object providing the underlying stream. Must not be null.

Returns:

a new filter based on this configuration, but filtering the specified reader