com.neeve.rog.log

Class RogLogUtil.FileBasedFieldFilter

java.lang.Object

com.neeve.rog.log.RogLogUtil.FileBasedFieldFilter

All Implemented Interfaces:

RogLogUtil.FieldFilter

Enclosing class:

RogLogUtil

public static final class RogLogUtil.FileBasedFieldFilter
extends Object
implements RogLogUtil.FieldFilter

A field filter that can be configured with filter information from a text based input stream. Each line of text can specify a field to filter in the following by specifying the containing type followed by the field path to filter. Omitting the classname or specifyign '*' specfies that the path should be ignored for all types. type.

 [classname|*] beanPath|*
 

Examples:

 // This is a comment line.
 # This is another comment line.
 
 # Indicates that myField in MyClass should be filtered
 com.foo.MyClass myField
 
 # Indicates all fields in MyClass should be filtered
 com.foo.MyClass *     
 
 # Indicates any type with an address.zipCode should be
 # filtered
 * address.zipCode
 

Method Summary

Modifier and Type	Method and Description
void	addFilterEntries(InputStream is) Adds filter entries for the given input stream.
boolean	filter(Class<?> type, String path) Filters a given field path for a type.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

addFilterEntries

public void addFilterEntries(InputStream is)
                      throws IOException

Adds filter entries for the given input stream.

Parameters:

is - The input stream

Throws:

IOException - If there is an exception reading from the stream

IllegalArgumentException - If the filter stream contains invalid input.

filter

public boolean filter(Class<?> type,
                      String path)

Description copied from interface: RogLogUtil.FieldFilter

Filters a given field path for a type.

Specified by:

filter in interface RogLogUtil.FieldFilter

Parameters:

type - The container type for the path.

path - The path to filter.

Returns:

True if this path should be filtered.