org.xfp.filters.codec
Class CodecStringDecoder

java.lang.Object
  org.xfp.AttributeContainer
      org.xfp.Filter
          org.xfp.filters.codec.CodecStringDecoder

public class CodecStringDecoder

extends Filter

Wrapper to the StringDecoder's in the Jakarta Commons Codec package.

Version:

$Id: CodecStringDecoder.java,v 1.1 2004/03/19 15:56:43 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

CodecStringDecoder()

Method Summary

java.lang.String	execute(java.lang.String string)
void	reset() Resets filter status after execution.
void	setClassName(java.lang.String className) The class name of the decoder to use.

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

CodecStringDecoder

public CodecStringDecoder()

Method Detail

setClassName

public void setClassName(java.lang.String className)
                  throws java.lang.Exception

The class name of the decoder to use. Must be an implementation of org.apache.commons.codec.StringDecoder Read the Jakarta Commons Codec javadocs to discover codec classes. At the time of writing they only have: org.apache.commons.codec.net.URLCodec (useless for JDK >= 1.4)

Throws:

java.lang.Exception

execute

public java.lang.String execute(java.lang.String string)
                         throws java.lang.Exception

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()