cvs commit: jakarta-log4j-sandbox/src/java/org/apache/log4j/plugins Receiver.java

[psmith]

psmith      2003/06/19 22:31:08

  Modified:    src/java/org/apache/log4j/plugins Receiver.java
  Log:
  updated the JavaDocs of Receiver to clarify the intent of the Active
  property.
  
  This is still under discussion.
  
  Revision  Changes    Path
  1.2       +9 -5      
jakarta-log4j-sandbox/src/java/org/apache/log4j/plugins/Receiver.java
  
  Index: Receiver.java
  ===================================================================
  RCS file: 
/home/cvs/jakarta-log4j-sandbox/src/java/org/apache/log4j/plugins/Receiver.java,v
  retrieving revision 1.1
  retrieving revision 1.2
  diff -u -r1.1 -r1.2
  --- Receiver.java     20 Jun 2003 05:26:37 -0000      1.1
  +++ Receiver.java     20 Jun 2003 05:31:07 -0000      1.2
  @@ -82,25 +82,29 @@
     is provided to standardize the "import" of remote events into
     the repository.
   
  +  <p>The Active property of the Receiver indicates whether the Receiver will accept 
events.
  +  If not active, any events that are posted to this receiver will not make
  +  their way into the Log4j system.
  +
     @author Mark Womack
     @author Ceki G&uuml;lc&uuml;
  +  @author Paul Smith <[EMAIL PROTECTED]>
     @since 1.3
   */
   public abstract class Receiver extends PluginSkeleton {
     /**
  -    Posts the logging event to a logger in the configured logger
  +    If this Receiver is Active, posts the logging event to a logger in the 
configured logger
       repository.
   
  -    @param event the log event to post to the local log4j environment. */
  +    @param event the log event to post to the local log4j environment if active. */
     public void doPost(LoggingEvent event) {
  -    
       /**
        * If this Receiver is not active, the event is discarded
        */
  -    if( !isActive()){
  +    if (!isActive()) {
         return;
       }
  -    
  +
       // get the "local" logger for this event from the
       // configured repository.
       Logger localLogger =
  
  
  

---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]