org.apache.tools.ant.filters

Class ExpandProperties

Implemented Interfaces:
ChainableReader

public final class ExpandProperties
extends BaseFilterReader
implements ChainableReader

Expands Ant properties, if any, in the data.

Example:

<expandproperties/>
Or:
<filterreader
    classname="org.apache.tools.ant.filters.ExpandProperties"/>

Constructor Summary

ExpandProperties()
Constructor for "dummy" instances.
ExpandProperties(Reader in)
Creates a new filtered reader.

Method Summary

Reader
chain(Reader rdr)
Creates a new ExpandProperties filter using the passed in Reader for instantiation.
int
read()
Returns the next character in the filtered stream.

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

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

Constructor Details

ExpandProperties

public ExpandProperties()
Constructor for "dummy" instances.

ExpandProperties

public ExpandProperties(Reader in)
Creates a new filtered reader.
Parameters:
in - A Reader object providing the underlying stream. Must not be null.

Method Details

chain

public final Reader chain(Reader rdr)
Creates a new ExpandProperties filter 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

read

public final int read()
            throws IOException
Returns the next character in the filtered stream. The original stream is first read in fully, and the Ant properties are expanded. The results of this expansion are then queued so they can be read character-by-character.
Returns:
the next character in the resulting stream, or -1 if the end of the resulting stream has been reached

Copyright © 2000-2006 Apache Software Foundation. All Rights Reserved.