ceki 2004/04/23 00:18:21
Modified: src/java/org/apache/log4j/spi LoggingEvent.java
Log:
Well, as Scott has correctly pointed out, threadName can be null after all
Revision Changes Path
1.49 +251 -228 logging-log4j/src/java/org/apache/log4j/spi/LoggingEvent.java
Index: LoggingEvent.java
===================================================================
RCS file: /home/cvs/logging-log4j/src/java/org/apache/log4j/spi/LoggingEvent.java,v
retrieving revision 1.48
retrieving revision 1.49
diff -u -r1.48 -r1.49
--- LoggingEvent.java 22 Apr 2004 20:24:24 -0000 1.48
+++ LoggingEvent.java 23 Apr 2004 07:18:21 -0000 1.49
@@ -1,21 +1,27 @@
/*
* Copyright 1999,2004 The Apache Software Foundation.
- *
+ *
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
- *
+ *
* http://www.apache.org/licenses/LICENSE-2.0
- *
+ *
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
-
package org.apache.log4j.spi;
+import java.io.ObjectInputStream;
+import java.io.ObjectOutputStream;
+import java.lang.reflect.Method;
+import java.util.Collections;
+import java.util.Hashtable;
+import java.util.Set;
+
import org.apache.log4j.Category;
import org.apache.log4j.Level;
import org.apache.log4j.MDC;
@@ -24,15 +30,6 @@
import org.apache.log4j.helpers.Loader;
import org.apache.log4j.helpers.LogLog;
-import java.io.ObjectInputStream;
-import java.io.ObjectOutputStream;
-
-import java.lang.reflect.Method;
-
-import java.util.Collections;
-import java.util.Hashtable;
-import java.util.Set;
-
// Contributors: Nelson Minar <[EMAIL PROTECTED]>
// Wolf Siberski
@@ -42,7 +39,7 @@
* The internal representation of logging events. When an affirmative decision
* is made to log then a <code>LoggingEvent</code> instance is created. This
* instance is passed around to the different log4j components.
- *
+ *
* <p>
* This class is of concern to those wishing to extend log4j.
* </p>
@@ -52,15 +49,16 @@
*
* @since 0.8.2
*/
-public class LoggingEvent implements java.io.Serializable {
- private static long startTime = System.currentTimeMillis();
+public class LoggingEvent
+ implements java.io.Serializable {
+ private static long startTime = System.currentTimeMillis( );
// Serialization
static final long serialVersionUID = -868428216207166145L;
- static final Integer[] PARAM_ARRAY = new Integer[1];
+ static final Integer[] PARAM_ARRAY = new Integer[ 1 ];
static final String TO_LEVEL = "toLevel";
static final Class[] TO_LEVEL_PARAMS = new Class[] { int.class };
- static final Hashtable methodCache = new Hashtable(3); // use a tiny table
+ static final Hashtable methodCache = new Hashtable( 3 ); // use a tiny table
/**
* Fully qualified name of the calling category class.
@@ -70,7 +68,7 @@
/**
* The category of the logging event. This field is not serialized for
* performance reasons.
- *
+ *
* <p>
* It is set by the LoggingEvent constructor or set by a remote entity after
* deserialization.
@@ -96,7 +94,7 @@
* Level of logging event. Level cannot be serializable because it is a
* flyweight. Due to its special seralization it cannot be declared final
* either.
- *
+ *
* <p>
* This field should not be accessed directly. You shoud use the [EMAIL PROTECTED]
* #getLevel} method instead.
@@ -174,12 +172,12 @@
/**
* Instantiate a LoggingEvent from the supplied parameters.
- *
+ *
* <p>
* Except [EMAIL PROTECTED] #timeStamp} all the other fields of
* <code>LoggingEvent</code> are filled when actually needed.
* </p>
- *
+ *
* <p></p>
*
* @param category The category of this event.
@@ -187,30 +185,30 @@
* @param message The message of this event.
* @param throwable The throwable of this event.
*/
- public LoggingEvent(
- String fqnOfCategoryClass, Category logger, Priority priority,
- Object message, Throwable throwable) {
+ public LoggingEvent( String fqnOfCategoryClass, Category logger, Priority
priority, Object message,
+ Throwable throwable ) {
this.fqnOfCategoryClass = fqnOfCategoryClass;
this.logger = logger;
- this.categoryName = logger.getName();
+ this.categoryName = logger.getName( );
this.level = priority;
this.message = message;
- if (throwable != null) {
- this.throwableInfo = new ThrowableInformation(throwable);
+ if ( throwable != null ) {
+ this.throwableInfo = new ThrowableInformation( throwable );
}
- timeStamp = System.currentTimeMillis();
+ timeStamp = System.currentTimeMillis( );
}
+
/**
* Instantiate a LoggingEvent from the supplied parameters.
- *
+ *
* <p>
* Except [EMAIL PROTECTED] #timeStamp} all the other fields of
* <code>LoggingEvent</code> are filled when actually needed.
* </p>
- *
+ *
* <p></p>
*
* @param category The category of this event.
@@ -219,38 +217,37 @@
* @param message The message of this event.
* @param throwable The throwable of this event.
*/
- public LoggingEvent(
- String fqnOfCategoryClass, Category logger, long timeStamp,
- Priority priority, Object message, Throwable throwable) {
+ public LoggingEvent( String fqnOfCategoryClass, Category logger, long timeStamp,
Priority priority, Object message,
+ Throwable throwable ) {
this.fqnOfCategoryClass = fqnOfCategoryClass;
this.logger = logger;
- this.categoryName = logger.getName();
+ this.categoryName = logger.getName( );
this.level = priority;
this.message = message;
- if (throwable != null) {
- this.throwableInfo = new ThrowableInformation(throwable);
+ if ( throwable != null ) {
+ this.throwableInfo = new ThrowableInformation( throwable );
}
this.timeStamp = timeStamp;
}
-
+
/**
* Alternate constructor to allow a string array to be passed in as the throwable.
*/
- public LoggingEvent(
- String fqnOfCategoryClass, Category logger, long timeStamp,
- Priority priority, String threadName, Object message, String ndc,
- Hashtable mdc, String[] throwableStrRep, LocationInfo li, Hashtable properties)
{
+ public LoggingEvent( String fqnOfCategoryClass, Category logger, long timeStamp,
Priority priority,
+ String threadName, Object message, String ndc, Hashtable mdc, String[]
throwableStrRep, LocationInfo li,
+ Hashtable properties ) {
ndcLookupRequired = false;
mdcCopyLookupRequired = false;
this.logger = logger;
- this.categoryName = logger.getName();
+ this.categoryName = logger.getName( );
this.level = priority;
this.message = message;
- if(throwableStrRep != null) {
- this.throwableInfo = new ThrowableInformation(throwableStrRep);
+
+ if ( throwableStrRep != null ) {
+ this.throwableInfo = new ThrowableInformation( throwableStrRep );
}
this.locationInfo = li;
this.fqnOfCategoryClass = fqnOfCategoryClass;
@@ -261,130 +258,137 @@
this.properties = properties;
}
-
- public boolean equals(Object rObject) {
- if( this == rObject) {
- return true;
- }
-
- if(!(rObject instanceof LoggingEvent)) {
- return false;
- }
-
- LoggingEvent rEvent = (LoggingEvent) rObject;
-
- // timeStamp cannot be null
- if(timeStamp != rEvent.timeStamp) {
- return false;
- }
-
- // level cannot be null
- if(level != rEvent.level) {
- return false;
- }
-
- // threadName cannot be null in a properly constructed LoggingEvent
- if(!threadName.equals(rEvent.threadName)) {
- return false;
- }
-
- if(message == null) {
- if(rEvent.message != null) {
- return false;
- }
- } else if(!message.equals(rEvent.message)) {
- return false;
- }
-
- if(properties == null) {
- if(rEvent.message != null) {
- return false;
- }
- } else if(!properties.equals(rEvent.properties)) {
- return false;
- }
-
- if(mdcCopy == null) {
- if(rEvent.mdcCopy != null) {
- return false;
- }
- } else if(!mdcCopy.equals(rEvent.mdcCopy)) {
- return false;
- }
-
- if(ndc == null) {
- if(rEvent.ndc != null) {
- return false;
- }
- } else if(!ndc.equals(rEvent.ndc)) {
- return false;
- }
-
- if(throwableInfo == null) {
- if(rEvent.throwableInfo != null) {
- return false;
- }
- } else if(!throwableInfo.equals(rEvent.throwableInfo)) {
- return false;
- }
+ public boolean equals( Object rObject ) {
+ if ( this == rObject ) {
+ return true;
+ }
+
+ if ( ! ( rObject instanceof LoggingEvent ) ) {
+ return false;
+ }
+
+ LoggingEvent rEvent = (LoggingEvent)rObject;
+
+ // timeStamp cannot be null
+ if ( timeStamp != rEvent.timeStamp ) {
+ return false;
+ }
+
+ // level cannot be null
+ if ( level != rEvent.level ) {
+ return false;
+ }
+
+ // threadName can be null after all
+ if ( threadName == null ) {
+ if ( rEvent.threadName != null ) {
+ return false;
+ }
+ } else if ( ! threadName.equals( rEvent.threadName ) ) {
+ return false;
+ }
- if(locationInfo == null) {
- if(rEvent.locationInfo != null) {
+ if ( message == null ) {
+ if ( rEvent.message != null ) {
return false;
}
- } else if(!locationInfo.equals(rEvent.locationInfo)) {
+ } else if ( ! message.equals( rEvent.message ) ) {
return false;
}
-
- // we can now safely assume that the two events are equal.
- return true;
- }
-
-
- public int hashCode() {
- return (int) ((timeStamp & 0xFFFFFFFF) ^ (timeStamp >> 16));
+ if ( properties == null ) {
+ if ( rEvent.message != null ) {
+ return false;
+ }
+ } else if ( ! properties.equals( rEvent.properties ) ) {
+ return false;
+ }
+
+ if ( mdcCopy == null ) {
+ if ( rEvent.mdcCopy != null ) {
+ return false;
+ }
+ } else if ( ! mdcCopy.equals( rEvent.mdcCopy ) ) {
+ return false;
+ }
+
+ if ( ndc == null ) {
+ if ( rEvent.ndc != null ) {
+ return false;
+ }
+ } else if ( ! ndc.equals( rEvent.ndc ) ) {
+ return false;
+ }
+
+ if ( throwableInfo == null ) {
+ if ( rEvent.throwableInfo != null ) {
+ return false;
+ }
+ } else if ( ! throwableInfo.equals( rEvent.throwableInfo ) ) {
+ return false;
+ }
+
+ if ( locationInfo == null ) {
+ if ( rEvent.locationInfo != null ) {
+ return false;
+ }
+ } else if ( ! locationInfo.equals( rEvent.locationInfo ) ) {
+ return false;
+ }
+
+ // we can now safely assume that the two events are equal.
+ return true;
}
-
+
+
+ public int hashCode( ) {
+ return (int)( ( timeStamp & 0xFFFFFFFF ) ^ ( timeStamp >> 16 ) );
+ }
+
+
/**
* Check for the existence of location information without creating it (a
byproduct of calling
* getLocationInformation).
*/
- public boolean locationInformationExists() {
- return (locationInfo != null);
+ public boolean locationInformationExists( ) {
+ return ( locationInfo != null );
}
-
+
+
/**
* Set the location information for this logging event. The collected
* information is cached for future use.
*/
- public LocationInfo getLocationInformation() {
- if (locationInfo == null) {
- locationInfo = new LocationInfo(new Throwable(), fqnOfCategoryClass);
+ public LocationInfo getLocationInformation( ) {
+ if ( locationInfo == null ) {
+ locationInfo = new LocationInfo( new Throwable( ), fqnOfCategoryClass );
}
return locationInfo;
}
+
/**
* Return the level of this event. Use this form instead of directly
* accessing the <code>level</code> field.
*/
- public Level getLevel() {
- return (Level) level;
+ public Level getLevel( ) {
+ return (Level)level;
}
+
/**
* Return the name of the logger. Use this form instead of directly
* accessing the <code>categoryName</code> field.
*/
- public String getLoggerName() {
+ public String getLoggerName( ) {
return categoryName;
}
+
/**
* Return the message for this logging event.
- *
+ *
* <p>
* Before serialization, the returned object is the message passed by the
* user to generate the logging event. After serialization, the returned
@@ -394,29 +398,31 @@
*
* @since 1.1
*/
- public Object getMessage() {
- if (message != null) {
+ public Object getMessage( ) {
+ if ( message != null ) {
return message;
} else {
- return getRenderedMessage();
+ return getRenderedMessage( );
}
}
+
/**
* This method returns the NDC for this event. It will return the correct
* content even if the event was generated in a different thread or even on
* a different machine. The [EMAIL PROTECTED] NDC#get} method should
<em>never</em> be
* called directly.
*/
- public String getNDC() {
- if (ndcLookupRequired) {
+ public String getNDC( ) {
+ if ( ndcLookupRequired ) {
ndcLookupRequired = false;
- ndc = NDC.get();
+ ndc = NDC.get( );
}
return ndc;
}
+
/**
* Returns the the context corresponding to the <code>key</code> parameter.
* If there is a local MDC copy, possibly because we are in a logging
@@ -424,108 +430,113 @@
* MDC copy, if a value is found it is returned. Otherwise, if the search
* in MDC copy returns a null result, then the current thread's
* <code>MDC</code> is used.
- *
+ *
* <p>
* Note that <em>both</em> the local MDC copy and the current thread's MDC
* are searched.
* </p>
*/
- public Object getMDC(String key) {
+ public Object getMDC( String key ) {
Object r;
// Note the mdcCopy is used if it exists. Otherwise we use the MDC
// that is associated with the thread.
- if (mdcCopy != null) {
- r = mdcCopy.get(key);
+ if ( mdcCopy != null ) {
+ r = mdcCopy.get( key );
- if (r != null) {
+ if ( r != null ) {
return r;
}
}
- return MDC.get(key);
+ return MDC.get( key );
}
+
/**
* Returns the set of of the key values in the MDC for the event.
- * The returned set is unmodifiable by the caller.
- *
+ * The returned set is unmodifiable by the caller.
+ *
* @return Set an unmodifiable set of the MDC keys.
* @since 1.3
*/
- public Set getMDCKeySet() {
- if (mdcCopy != null) {
- return Collections.unmodifiableSet(mdcCopy.keySet());
+ public Set getMDCKeySet( ) {
+ if ( mdcCopy != null ) {
+ return Collections.unmodifiableSet( mdcCopy.keySet( ) );
} else {
- Hashtable t = (Hashtable) MDC.getContext();
+ Hashtable t = (Hashtable)MDC.getContext( );
- if (t != null) {
- return Collections.unmodifiableSet(t.keySet());
+ if ( t != null ) {
+ return Collections.unmodifiableSet( t.keySet( ) );
} else {
return Collections.EMPTY_SET;
}
}
}
-
+
+
/**
* Obtain a copy of this thread's MDC prior to serialization or asynchronous
* logging.
*/
- public void getMDCCopy() {
- if (mdcCopyLookupRequired) {
+ public void getMDCCopy( ) {
+ if ( mdcCopyLookupRequired ) {
mdcCopyLookupRequired = false;
// the clone call is required for asynchronous logging.
// See also bug #5932.
- Hashtable t = (Hashtable) MDC.getContext();
+ Hashtable t = (Hashtable)MDC.getContext( );
- if (t != null) {
- mdcCopy = (Hashtable) t.clone();
+ if ( t != null ) {
+ mdcCopy = (Hashtable)t.clone( );
}
}
}
-
+
+
/**
* Return a previously set property. The return value can be null.
*
* @since 1.3
*/
- public String getProperty(String key) {
- if (properties == null) {
+ public String getProperty( String key ) {
+ if ( properties == null ) {
return null;
} else {
- return (String) properties.get(key);
+ return (String)properties.get( key );
}
}
+
/**
* Returns the set of of the key values in the properties
* for the event or Collections.EMPTY_SET if properties do not exist.
- * The returned set is unmodifiable by the caller.
- *
+ * The returned set is unmodifiable by the caller.
+ *
* @return Set an unmodifiable set of the property keys.
* @since 1.3
*/
- public Set getPropertyKeySet() {
- if (properties != null) {
- return Collections.unmodifiableSet(properties.keySet());
+ public Set getPropertyKeySet( ) {
+ if ( properties != null ) {
+ return Collections.unmodifiableSet( properties.keySet( ) );
} else {
return Collections.EMPTY_SET;
}
}
- public String getRenderedMessage() {
- if ((renderedMessage == null) && (message != null)) {
- if (message instanceof String) {
- renderedMessage = (String) message;
+
+ public String getRenderedMessage( ) {
+ if ( ( renderedMessage == null ) && ( message != null ) ) {
+ if ( message instanceof String ) {
+ renderedMessage = (String)message;
} else {
- LoggerRepository repository = logger.getLoggerRepository();
+ LoggerRepository repository = logger.getLoggerRepository( );
- if (repository instanceof RendererSupport) {
- RendererSupport rs = (RendererSupport) repository;
- renderedMessage = rs.getRendererMap().findAndRender(message);
+ if ( repository instanceof RendererSupport ) {
+ RendererSupport rs = (RendererSupport)repository;
+ renderedMessage = rs.getRendererMap( ).findAndRender( message );
} else {
- renderedMessage = message.toString();
+ renderedMessage = message.toString( );
}
}
}
@@ -533,26 +544,29 @@
return renderedMessage;
}
+
/**
* Returns the time when the application started, in milliseconds elapsed
* since 01.01.1970.
*/
- public static long getStartTime() {
+ public static long getStartTime( ) {
return startTime;
}
- public String getThreadName() {
- if (threadName == null) {
- threadName = (Thread.currentThread()).getName();
+
+ public String getThreadName( ) {
+ if ( threadName == null ) {
+ threadName = ( Thread.currentThread( ) ).getName( );
}
return threadName;
}
+
/**
* Returns the throwable information contained within this event. May be
* <code>null</code> if there is no such information.
- *
+ *
* <p>
* Note that the [EMAIL PROTECTED] Throwable} object contained within a [EMAIL
PROTECTED]
* ThrowableInformation} does not survive serialization.
@@ -560,35 +574,37 @@
*
* @since 1.1
*/
- public ThrowableInformation getThrowableInformation() {
+ public ThrowableInformation getThrowableInformation( ) {
return throwableInfo;
}
+
/**
* Return this event's throwable's string[] representaion.
*/
- public String[] getThrowableStrRep() {
- if (throwableInfo == null) {
+ public String[] getThrowableStrRep( ) {
+ if ( throwableInfo == null ) {
return null;
} else {
- return throwableInfo.getThrowableStrRep();
+ return throwableInfo.getThrowableStrRep( );
}
}
- private void readLevel(ObjectInputStream ois)
- throws java.io.IOException, ClassNotFoundException {
- int p = ois.readInt();
+
+ private void readLevel( ObjectInputStream ois )
+ throws java.io.IOException, ClassNotFoundException {
+ int p = ois.readInt( );
try {
- String className = (String) ois.readObject();
+ String className = (String)ois.readObject( );
- if (className == null) {
- level = Level.toLevel(p);
+ if ( className == null ) {
+ level = Level.toLevel( p );
} else {
- Method m = (Method) methodCache.get(className);
+ Method m = (Method)methodCache.get( className );
- if (m == null) {
- Class clazz = Loader.loadClass(className);
+ if ( m == null ) {
+ Class clazz = Loader.loadClass( className );
// Note that we use Class.getDeclaredMethod instead of
// Class.getMethod. This assumes that the Level subclass
@@ -596,81 +612,88 @@
// requirement. Actually, it does not make sense for Level
// subclasses NOT to implement this method. Also note that
// only Level can be subclassed and not Priority.
- m = clazz.getDeclaredMethod(TO_LEVEL, TO_LEVEL_PARAMS);
- methodCache.put(className, m);
+ m = clazz.getDeclaredMethod( TO_LEVEL, TO_LEVEL_PARAMS );
+ methodCache.put( className, m );
}
- PARAM_ARRAY[0] = new Integer(p);
- level = (Level) m.invoke(null, PARAM_ARRAY);
+ PARAM_ARRAY[ 0 ] = new Integer( p );
+ level = (Level)m.invoke( null, PARAM_ARRAY );
}
- } catch (Exception e) {
- LogLog.warn("Level deserialization failed, reverting to default.", e);
- level = Level.toLevel(p);
+ } catch ( Exception e ) {
+ LogLog.warn( "Level deserialization failed, reverting to default.", e );
+ level = Level.toLevel( p );
}
}
- private void readObject(ObjectInputStream ois)
- throws java.io.IOException, ClassNotFoundException {
- ois.defaultReadObject();
- readLevel(ois);
+
+ private void readObject( ObjectInputStream ois )
+ throws java.io.IOException, ClassNotFoundException {
+ ois.defaultReadObject( );
+ readLevel( ois );
// Make sure that no location info is available to Layouts
- if (locationInfo == null) {
- locationInfo = new LocationInfo(null, null);
+ if ( locationInfo == null ) {
+ locationInfo = new LocationInfo( null, null );
}
}
+
/**
* Set a string property using a key and a string value. since 1.3
*/
- public void setProperty(String key, String value) {
- if (properties == null) {
- properties = new Hashtable(5); // create a small hashtable
+ public void setProperty( String key, String value ) {
+ if ( properties == null ) {
+ properties = new Hashtable( 5 ); // create a small hashtable
}
- if (value != null) {
- properties.put(key, value);
+
+ if ( value != null ) {
+ properties.put( key, value );
} else {
- properties.remove(key);
+ properties.remove( key );
}
}
- private void writeObject(ObjectOutputStream oos) throws java.io.IOException {
+
+ private void writeObject( ObjectOutputStream oos )
+ throws java.io.IOException {
// Aside from returning the current thread name the wgetThreadName
// method sets the threadName variable.
- this.getThreadName();
+ this.getThreadName( );
// This sets the renders the message in case it wasn't up to now.
- this.getRenderedMessage();
+ this.getRenderedMessage( );
// This call has a side effect of setting this.ndc and
// setting ndcLookupRequired to false if not already false.
- this.getNDC();
+ this.getNDC( );
// This call has a side effect of setting this.mdcCopy and
// setting mdcLookupRequired to false if not already false.
- this.getMDCCopy();
+ this.getMDCCopy( );
// This sets the throwable sting representation of the event throwable.
- this.getThrowableStrRep();
+ this.getThrowableStrRep( );
- oos.defaultWriteObject();
+ oos.defaultWriteObject( );
// serialize this event's level
- writeLevel(oos);
+ writeLevel( oos );
}
- private void writeLevel(ObjectOutputStream oos) throws java.io.IOException {
- oos.writeInt(level.toInt());
- Class clazz = level.getClass();
+ private void writeLevel( ObjectOutputStream oos )
+ throws java.io.IOException {
+ oos.writeInt( level.toInt( ) );
+
+ Class clazz = level.getClass( );
- if (clazz == Level.class) {
- oos.writeObject(null);
+ if ( clazz == Level.class ) {
+ oos.writeObject( null );
} else {
// writing directly the Class object would be nicer, except that
// serialized a Class object can not be read back by JDK
// 1.1.x. We have to resort to this hack instead.
- oos.writeObject(clazz.getName());
+ oos.writeObject( clazz.getName( ) );
}
}
}
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
