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 2008/08/28 15:17:22 UTC
svn commit: r689808 - in
/mina/trunk/core/src/main/java/org/apache/mina/core/filterchain:
DefaultIoFilterChain.java IoFilterAdapter.java
Author: elecharny
Date: Thu Aug 28 06:17:22 2008
New Revision: 689808
URL: http://svn.apache.org/viewvc?rev=689808&view=rev
Log:
o Added some missing Javadoc
o Updated the IoFilterAdapter (removed the 'abstract' mention)
Modified:
mina/trunk/core/src/main/java/org/apache/mina/core/filterchain/DefaultIoFilterChain.java
mina/trunk/core/src/main/java/org/apache/mina/core/filterchain/IoFilterAdapter.java
Modified: mina/trunk/core/src/main/java/org/apache/mina/core/filterchain/DefaultIoFilterChain.java
URL: http://svn.apache.org/viewvc/mina/trunk/core/src/main/java/org/apache/mina/core/filterchain/DefaultIoFilterChain.java?rev=689808&r1=689807&r2=689808&view=diff
==============================================================================
--- mina/trunk/core/src/main/java/org/apache/mina/core/filterchain/DefaultIoFilterChain.java (original)
+++ mina/trunk/core/src/main/java/org/apache/mina/core/filterchain/DefaultIoFilterChain.java Thu Aug 28 06:17:22 2008
@@ -56,16 +56,27 @@
public static final AttributeKey SESSION_CREATED_FUTURE = new AttributeKey(
DefaultIoFilterChain.class, "connectFuture");
+ /** The associated session */
private final AbstractIoSession session;
private final Map<String, Entry> name2entry = new HashMap<String, Entry>();
+ /** The chain head */
private final EntryImpl head;
+ /** The chain tail */
private final EntryImpl tail;
+ /** The logger for this class */
private final Logger logger = LoggerFactory.getLogger(getClass());
+
+ /**
+ * Create a new default chain, associated with a session. It will only contain a
+ * HeadFilter and a TailFilter.
+ *
+ * @param session The session associated with the created filter chain
+ */
public DefaultIoFilterChain(AbstractIoSession session) {
if (session == null) {
throw new NullPointerException("session");
Modified: mina/trunk/core/src/main/java/org/apache/mina/core/filterchain/IoFilterAdapter.java
URL: http://svn.apache.org/viewvc/mina/trunk/core/src/main/java/org/apache/mina/core/filterchain/IoFilterAdapter.java?rev=689808&r1=689807&r2=689808&view=diff
==============================================================================
--- mina/trunk/core/src/main/java/org/apache/mina/core/filterchain/IoFilterAdapter.java (original)
+++ mina/trunk/core/src/main/java/org/apache/mina/core/filterchain/IoFilterAdapter.java Thu Aug 28 06:17:22 2008
@@ -25,7 +25,7 @@
import org.apache.mina.core.write.WriteRequest;
/**
- * An abstract adapter class for {@link IoFilter}. You can extend
+ * An adapter class for {@link IoFilter}. You can extend
* this class and selectively override required event filter methods only. All
* methods forwards events to the next filter by default.
*
@@ -33,73 +33,121 @@
* @version $Rev: 591770 $, $Date: 2007-11-04 13:22:44 +0100 (Sun, 04 Nov 2007) $
*/
public class IoFilterAdapter implements IoFilter {
+ /**
+ * {@inheritDoc}
+ */
public void init() throws Exception {
}
+ /**
+ * {@inheritDoc}
+ */
public void destroy() throws Exception {
}
+ /**
+ * {@inheritDoc}
+ */
public void onPreAdd(IoFilterChain parent, String name,
NextFilter nextFilter) throws Exception {
}
+ /**
+ * {@inheritDoc}
+ */
public void onPostAdd(IoFilterChain parent, String name,
NextFilter nextFilter) throws Exception {
}
+ /**
+ * {@inheritDoc}
+ */
public void onPreRemove(IoFilterChain parent, String name,
NextFilter nextFilter) throws Exception {
}
+ /**
+ * {@inheritDoc}
+ */
public void onPostRemove(IoFilterChain parent, String name,
NextFilter nextFilter) throws Exception {
}
+ /**
+ * {@inheritDoc}
+ */
public void sessionCreated(NextFilter nextFilter, IoSession session)
throws Exception {
nextFilter.sessionCreated(session);
}
+ /**
+ * {@inheritDoc}
+ */
public void sessionOpened(NextFilter nextFilter, IoSession session)
throws Exception {
nextFilter.sessionOpened(session);
}
+ /**
+ * {@inheritDoc}
+ */
public void sessionClosed(NextFilter nextFilter, IoSession session)
throws Exception {
nextFilter.sessionClosed(session);
}
+ /**
+ * {@inheritDoc}
+ */
public void sessionIdle(NextFilter nextFilter, IoSession session,
IdleStatus status) throws Exception {
nextFilter.sessionIdle(session, status);
}
+ /**
+ * {@inheritDoc}
+ */
public void exceptionCaught(NextFilter nextFilter, IoSession session,
Throwable cause) throws Exception {
nextFilter.exceptionCaught(session, cause);
}
+ /**
+ * {@inheritDoc}
+ */
public void messageReceived(NextFilter nextFilter, IoSession session,
Object message) throws Exception {
nextFilter.messageReceived(session, message);
}
+ /**
+ * {@inheritDoc}
+ */
public void messageSent(NextFilter nextFilter, IoSession session,
WriteRequest writeRequest) throws Exception {
nextFilter.messageSent(session, writeRequest);
}
+ /**
+ * {@inheritDoc}
+ */
public void filterWrite(NextFilter nextFilter, IoSession session,
WriteRequest writeRequest) throws Exception {
nextFilter.filterWrite(session, writeRequest);
}
+ /**
+ * {@inheritDoc}
+ */
public void filterClose(NextFilter nextFilter, IoSession session)
throws Exception {
nextFilter.filterClose(session);
}
+ /**
+ * {@inheritDoc}
+ */
public void filterSetTrafficMask(NextFilter nextFilter, IoSession session,
TrafficMask trafficMask) throws Exception {
nextFilter.filterSetTrafficMask(session, trafficMask);