au.com.forward.webstringtemplate.filters
Interface IWSTFilter

All Known Implementing Classes:

WSTPlainFilter

public interface IWSTFilter

The Interface for WebStringTemplate Filters.

Author:

matthew ford

Method Summary

java.lang.Object	getObject() returns the object being filtered, null if not set.
java.lang.String	getPath() returns the attribute name path of the object in this filter, or null if not set
IWSTFilter	newInstance() Returns a new instance of this filter class, usually a shallow clone with null object and path.
void	setObject(java.lang.Object obj) sets the object being filtered.
void	setPath(java.lang.String newPath) sets the attribute name path of the object in this fiter, null if not set
java.lang.String	toString() returns the filtered string of this object or "" (empty string) if object null.

Method Detail

newInstance

public IWSTFilter newInstance()

Returns a new instance of this filter class, usually a shallow clone with null object and path.

Returns:

A new instance of this filter class

getObject

public java.lang.Object getObject()

returns the object being filtered, null if not set.

Returns:

the object beinig filtered.

setObject

public void setObject(java.lang.Object obj)

sets the object being filtered.

Parameters:

obj - the object to be filtered

Throws:

java.lang.IllegalStateException - if the object is this filter itself or if it wraps this filter.

toString

public java.lang.String toString()

returns the filtered string of this object or "" (empty string) if object null.
If an error occures calling obj.toString(), return the error message as the string.

Returns:

the filtered string of this object. If obj.toString() throws an exception, then the exception message is returned.

getPath

public java.lang.String getPath()

returns the attribute name path of the object in this filter, or null if not set

Returns:

The path value can be null

setPath

public void setPath(java.lang.String newPath)

sets the attribute name path of the object in this fiter, null if not set

Parameters:

newPath - The new path value

Throws:

java.lang.IllegalArgumentException - if not null and not a valid attribute name