org.apache.tools.ant.filters

Class ClassConstants

Implemented Interfaces:
ChainableReader

public final class ClassConstants
extends BaseFilterReader
implements ChainableReader

Assembles the constants declared in a Java class in key1=value1(line separator)key2=value2 format.

Notes:

  1. This filter uses the BCEL external toolkit.
  2. This assembles only those constants that are not created using the syntax new whatever()
  3. This assembles constants declared using the basic datatypes and String only.
  4. The access modifiers of the declared constants do not matter.
Example:
<classconstants/>
Or:
<filterreader
    classname="org.apache.tools.ant.filters.ClassConstants"/>

Constructor Summary

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

Method Summary

Reader
chain(Reader rdr)
Creates a new ClassConstants using the passed in Reader for instantiation.
int
read()
Reads and assembles the constants declared in a class file.

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

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

Constructor Details

ClassConstants

public ClassConstants()
Constructor for "dummy" instances.

ClassConstants

public ClassConstants(Reader in)
Creates a new filtered reader. The contents of the passed-in reader are expected to be the name of the class from which to produce a list of constants.
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 ClassConstants 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
Reads and assembles the constants declared in a class file.
Returns:
the next character in the list of constants, or -1 if the end of the resulting stream has been reached

Copyright B) 2000-2008 Apache Software Foundation. All Rights Reserved.