org.eclipse.hyades.logging.java
Class CommonBaseEventFilter

java.lang.Object
  org.eclipse.hyades.logging.java.CommonBaseEventFilter

All Implemented Interfaces:

java.util.logging.Filter

public class CommonBaseEventFilter
extends java.lang.Object
implements java.util.logging.Filter

Implementation of the Java Logging java.util.logging.Filter interface used to provide control over what is logged at a more granular level than logging level for both java.util.logging.Logger instances and java.util.logging.Handler instances.

Only org.eclipse.hyades.logging.java.CommonBaseEventLogRecord instances are logged when this filter is utilized.

An instance of this class will be returned from the getFilter() APIs on java.util.logging.Logger instances and/or run-time java.util.logging.Handler instances.

The default java.util.logging.LogManager implementation uses the following configuration variable in the default <JRE>/lib/logging.properties configuration file to load configuration for java.util.logging.Logger instances and/or run-time java.util.logging.Handler instances:

.filter = org.eclipse.hyades.logging.java.CommonBaseEventFilter

Alternatively, an instantiation of this filter class may be set directly to java.util.logging.Logger instances and/or run-time java.util.logging.Handler instances by using the setFilter() APIs.

NOTE: The Java Logging classes must be on the CLASSPATH at run-time to utilize this filter class.

See Also:

Filter, LogRecord, CommonBaseEventLogRecord

Constructor Summary

CommonBaseEventFilter()

Method Summary

boolean

isLoggable(java.util.logging.LogRecord logRecord) Checks if the parameter java.util.logging.LogRecord is loggable.

Methods inherited from class java.lang.Object

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

Constructor Detail

CommonBaseEventFilter

public CommonBaseEventFilter()

Method Detail

isLoggable

public boolean isLoggable(java.util.logging.LogRecord logRecord)

Checks if the parameter java.util.logging.LogRecord is loggable.

To be loggable, the parameter java.util.logging.LogRecord must be an instance of org.eclipse.hyades.logging.java.CommonBaseEventLogRecord.

Specified by:

isLoggable in interface java.util.logging.Filter

Parameters:

logRecord - The java.util.logging.LogRecord to be checked if it is loggable.

Returns:

True if the parameter java.util.logging.LogRecord is an instance of org.eclipse.hyades.logging.java.CommonBaseEventLogRecord, otherwise false.