You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@mina.apache.org by el...@apache.org on 2019/04/04 14:10:45 UTC

[mina] branch mina-write-request updated: added some javadoc and comments

This is an automated email from the ASF dual-hosted git repository.

elecharny pushed a commit to branch mina-write-request
in repository https://gitbox.apache.org/repos/asf/mina.git


The following commit(s) were added to refs/heads/mina-write-request by this push:
     new 317eeb5  added some javadoc and comments
317eeb5 is described below

commit 317eeb5829519bb5e7109cc17c1b5d0354e07828
Author: emmanuel lecharny <el...@apache.org>
AuthorDate: Thu Apr 4 16:10:40 2019 +0200

    added some javadoc and comments
---
 .../apache/mina/filter/logging/LoggingFilter.java  | 33 +++++++++++++++++++---
 1 file changed, 29 insertions(+), 4 deletions(-)

diff --git a/mina-core/src/main/java/org/apache/mina/filter/logging/LoggingFilter.java b/mina-core/src/main/java/org/apache/mina/filter/logging/LoggingFilter.java
index 99e43c9..40fa397 100644
--- a/mina-core/src/main/java/org/apache/mina/filter/logging/LoggingFilter.java
+++ b/mina-core/src/main/java/org/apache/mina/filter/logging/LoggingFilter.java
@@ -29,10 +29,10 @@ import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
 /**
- * Logs all MINA protocol events.  Each event can be
- * tuned to use a different level based on the user's specific requirements.  Methods
- * are in place that allow the user to use either the get or set method for each event
- * and pass in the {@link IoEventType} and the {@link LogLevel}.
+ * Logs MINA protocol events.  Each event can be tuned to use a different level based on 
+ * the user's specific requirements.  Methods are in place that allow the user to use 
+ * either the get or set method for each event and pass in the {@link IoEventType} and 
+ * the {@link LogLevel}.
  *
  * By default, all events are logged to the {@link LogLevel#INFO} level except
  * {@link IoFilterAdapter#exceptionCaught(IoFilter.NextFilter, IoSession, Throwable)},
@@ -196,42 +196,67 @@ public class LoggingFilter extends IoFilterAdapter {
         }
     }
 
+    /**
+     * {@inheritDoc}
+     */
     @Override
     public void exceptionCaught(NextFilter nextFilter, IoSession session, Throwable cause) throws Exception {
         log(exceptionCaughtLevel, "EXCEPTION :", cause);
         nextFilter.exceptionCaught(session, cause);
     }
 
+    /**
+     * {@inheritDoc}
+     */
     @Override
     public void messageReceived(NextFilter nextFilter, IoSession session, Object message) throws Exception {
+        // Note: the way the IoBuffer method is implemented, logging an instance of
+        // an instance will not change its position. It's safe.
         log(messageReceivedLevel, "RECEIVED: {}", message);
         nextFilter.messageReceived(session, message);
     }
 
+    /**
+     * {@inheritDoc}
+     */
     @Override
     public void messageSent(NextFilter nextFilter, IoSession session, WriteRequest writeRequest) throws Exception {
+        // Note: the way the IoBuffer method is implemented, logging an instance of
+        // an instance will not change its position. It's safe.
         log(messageSentLevel, "SENT: {}", writeRequest.getOriginalMessage());
         nextFilter.messageSent(session, writeRequest);
     }
 
+    /**
+     * {@inheritDoc}
+     */
     @Override
     public void sessionCreated(NextFilter nextFilter, IoSession session) throws Exception {
         log(sessionCreatedLevel, "CREATED");
         nextFilter.sessionCreated(session);
     }
 
+    /**
+     * {@inheritDoc}
+     */
     @Override
     public void sessionOpened(NextFilter nextFilter, IoSession session) throws Exception {
         log(sessionOpenedLevel, "OPENED");
         nextFilter.sessionOpened(session);
     }
 
+    /**
+     * {@inheritDoc}
+     */
     @Override
     public void sessionIdle(NextFilter nextFilter, IoSession session, IdleStatus status) throws Exception {
         log(sessionIdleLevel, "IDLE");
         nextFilter.sessionIdle(session, status);
     }
 
+    /**
+     * {@inheritDoc}
+     */
     @Override
     public void sessionClosed(NextFilter nextFilter, IoSession session) throws Exception {
         log(sessionClosedLevel, "CLOSED");