org.xfp.filters.convert
Class ReaderToString

java.lang.Object
  org.xfp.AttributeContainer
      org.xfp.Filter
          org.xfp.filters.convert.ReaderToString

public class ReaderToString

extends Filter

Converts an Reader to a string.

Version:

$Id: ReaderToString.java,v 1.1 2004/03/19 15:56:47 flaviotordini Exp $

Author:

Flavio Tordini

Nested Class Summary

Nested classes inherited from class org.xfp.Filter

Filter.OnErrorEnum, Filter.OnLoopErrorEnum

Field Summary

Fields inherited from class org.xfp.AttributeContainer

name, parentContainer

Constructor Summary

ReaderToString()

Method Summary

java.lang.String	execute(java.io.Reader r) Executes this filter.
protected static java.lang.String	readerToString(java.io.Reader is) Read the entire content of a Reader into a String
void	reset() Resets filter status after execution.

Methods inherited from class org.xfp.Filter

getOnError, initialize, log, newInstance, perform, toString

Methods inherited from class org.xfp.AttributeContainer

configureAttributes, disposeAttributes, getAttributes, getFullName, getName, initializeAttributes

Methods inherited from class java.lang.Object

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

Constructor Detail

ReaderToString

public ReaderToString()

Method Detail

execute

public java.lang.String execute(java.io.Reader r)
                         throws java.lang.Exception

Executes this filter.

Throws:

java.lang.Exception

reset

public void reset()

Description copied from class: Filter

Resets filter status after execution. This method is called after execute(), even in case of exceptions. Since a Filter instance may be reused (and actually is), you must use this method to reset all your class members to their default value.

Specified by:

reset in class Filter

See Also:

Filter.reset()

readerToString

protected static java.lang.String readerToString(java.io.Reader is)
                                          throws java.io.IOException

Read the entire content of a Reader into a String

Returns:

the String containing the reader

Throws:

java.io.IOException