org.mdiutil.util.logging

Class PathFilter

java.lang.Object

org.mdiutil.util.logging.PathFilter

All Implemented Interfaces:

Filter

public class PathFilter
extends Object
implements Filter

A Logging filter which can filter depending on the path of the source class for the LogRecord.

Constructor Summary

Constructors

Constructor and Description
PathFilter()

Method Summary

Modifier and Type	Method and Description
int	getFilterLevel() Return the filter level.
Set<String>	getPaths() Return the paths which will be filtered.
boolean	isLoggable(LogRecord record) Return true if the record if Loggable.
void	setFilterLevel(int filterLevel) Set the filter level.
void	setPaths(Set<String> paths) Set the paths which will be filtered.

Methods inherited from class java.lang.Object

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

Constructor Detail

PathFilter

public PathFilter()

Method Detail

getFilterLevel

public int getFilterLevel()

Return the filter level. Above thislevel, the Filter will accept any logRecord. Below this level, Only the classes whose path begin with one of the specified getPaths() will be loggable. The default if INFO.

Returns:

the filter level

setFilterLevel

public void setFilterLevel(int filterLevel)

Set the filter level. Above thislevel, the Filter will accept any logRecord. Below this level, Only the classes whose path begin with one of the specified getPaths() will be loggable. The default if INFO.

Parameters:

filterLevel - the filter Level

getPaths

public Set<String> getPaths()

Return the paths which will be filtered. Only the classes whose path begin with one of the specified paths will be loggable.

Returns:

the paths which will be filtered

setPaths

public void setPaths(Set<String> paths)

Set the paths which will be filtered. Only the classes whose path begin with one of the specified paths will be loggable.

Parameters:

paths - the paths to set

isLoggable

public boolean isLoggable(LogRecord record)

Return true if the record if Loggable.

• If the level of the LogRecord is greater or equal than getFilterLevel(), then the method will return true (the LogRecord is loggable}
• Else if there is no source for the LogRecord, return true (the LogRecord is loggable}
• Else return true only if the source path for the LogRecord belong to one of the paths specified by setPaths(java.util.Set)

Examples

Consider a Module Filter with the default filter level configuration (INFO), with the following definition for the modules paths:

• "my.package"
• "my.package2.myClass"

If the LogRecord has the level WARNING, it will be loggable (the method will return true).
If the LogRecord has the level INFO, and the source is null, it will be loggable.
If the LogRecord has the level INFO, and the source is "my.package.anotherClass, it will be loggable.
If the LogRecord has the level INFO, and the source is "my.package2.myClass, it will be loggable.
If the LogRecord has the level INFO, and the source is "my.package2.anotherClass2, it will not be loggable.

Specified by:

isLoggable in interface Filter

Parameters:

record - the LogRecord

Returns:

true if the record if Loggable