You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@directory.apache.org by tr...@apache.org on 2005/05/09 17:11:35 UTC
svn commit: r169325 - in /directory/network/branches/api_integration/src:
java/org/apache/mina/common/ java/org/apache/mina/filter/
java/org/apache/mina/filter/codec/ java/org/apache/mina/transport/socket/nio/
java/org/apache/mina/transport/vmpipe/ java/org/apache/mina/util/
test/org/apache/mina/common/ test/org/apache/mina/examples/echoserver/
Author: trustin
Date: Mon May 9 08:11:33 2005
New Revision: 169325
URL: http://svn.apache.org/viewcvs?rev=169325&view=rev
Log:
Fixed: JavaDoc warnings
Modified:
directory/network/branches/api_integration/src/java/org/apache/mina/common/BaseIoSession.java
directory/network/branches/api_integration/src/java/org/apache/mina/common/BaseIoSessionConfig.java
directory/network/branches/api_integration/src/java/org/apache/mina/common/BaseIoSessionManager.java
directory/network/branches/api_integration/src/java/org/apache/mina/common/ByteBuffer.java
directory/network/branches/api_integration/src/java/org/apache/mina/common/DefaultExceptionMonitor.java
directory/network/branches/api_integration/src/java/org/apache/mina/common/IdleStatus.java
directory/network/branches/api_integration/src/java/org/apache/mina/common/IoFilterAdapter.java
directory/network/branches/api_integration/src/java/org/apache/mina/common/WriteTimeoutException.java
directory/network/branches/api_integration/src/java/org/apache/mina/filter/ThreadPoolFilter.java
directory/network/branches/api_integration/src/java/org/apache/mina/filter/codec/MessageDecoderResult.java
directory/network/branches/api_integration/src/java/org/apache/mina/transport/socket/nio/DatagramSessionConfig.java
directory/network/branches/api_integration/src/java/org/apache/mina/transport/socket/nio/SocketSessionConfig.java
directory/network/branches/api_integration/src/java/org/apache/mina/transport/vmpipe/VmPipeAcceptor.java
directory/network/branches/api_integration/src/java/org/apache/mina/transport/vmpipe/VmPipeSessionConfig.java
directory/network/branches/api_integration/src/java/org/apache/mina/util/BaseThreadPool.java
directory/network/branches/api_integration/src/java/org/apache/mina/util/Event.java
directory/network/branches/api_integration/src/java/org/apache/mina/util/SessionLog.java
directory/network/branches/api_integration/src/test/org/apache/mina/common/IoFilterChainTest.java
directory/network/branches/api_integration/src/test/org/apache/mina/examples/echoserver/ConnectorTest.java
Modified: directory/network/branches/api_integration/src/java/org/apache/mina/common/BaseIoSession.java
URL: http://svn.apache.org/viewcvs/directory/network/branches/api_integration/src/java/org/apache/mina/common/BaseIoSession.java?rev=169325&r1=169324&r2=169325&view=diff
==============================================================================
--- directory/network/branches/api_integration/src/java/org/apache/mina/common/BaseIoSession.java (original)
+++ directory/network/branches/api_integration/src/java/org/apache/mina/common/BaseIoSession.java Mon May 9 08:11:33 2005
@@ -23,7 +23,7 @@
import java.util.Set;
/**
- * Base implementation of {@link Session}.
+ * Base implementation of {@link IoSession}.
*
* @author Trustin Lee (trustin@apache.org)
* @version $Rev$, $Date$
Modified: directory/network/branches/api_integration/src/java/org/apache/mina/common/BaseIoSessionConfig.java
URL: http://svn.apache.org/viewcvs/directory/network/branches/api_integration/src/java/org/apache/mina/common/BaseIoSessionConfig.java?rev=169325&r1=169324&r2=169325&view=diff
==============================================================================
--- directory/network/branches/api_integration/src/java/org/apache/mina/common/BaseIoSessionConfig.java (original)
+++ directory/network/branches/api_integration/src/java/org/apache/mina/common/BaseIoSessionConfig.java Mon May 9 08:11:33 2005
@@ -18,9 +18,8 @@
*/
package org.apache.mina.common;
-
/**
- * Base implementation of {@link SessionConfig}s.
+ * Base implementation of {@link IoSessionConfig}s.
*
* @author Trustin Lee (trustin@apache.org)
* @version $Rev$, $Date$
Modified: directory/network/branches/api_integration/src/java/org/apache/mina/common/BaseIoSessionManager.java
URL: http://svn.apache.org/viewcvs/directory/network/branches/api_integration/src/java/org/apache/mina/common/BaseIoSessionManager.java?rev=169325&r1=169324&r2=169325&view=diff
==============================================================================
--- directory/network/branches/api_integration/src/java/org/apache/mina/common/BaseIoSessionManager.java (original)
+++ directory/network/branches/api_integration/src/java/org/apache/mina/common/BaseIoSessionManager.java Mon May 9 08:11:33 2005
@@ -19,7 +19,7 @@
package org.apache.mina.common;
/**
- * Base implementation of {@link SessionManager}s.
+ * Base implementation of {@link IoSessionManager}s.
*
* @author Trustin Lee (trustin@apache.org)
* @version $Rev$, $Date$
Modified: directory/network/branches/api_integration/src/java/org/apache/mina/common/ByteBuffer.java
URL: http://svn.apache.org/viewcvs/directory/network/branches/api_integration/src/java/org/apache/mina/common/ByteBuffer.java?rev=169325&r1=169324&r2=169325&view=diff
==============================================================================
--- directory/network/branches/api_integration/src/java/org/apache/mina/common/ByteBuffer.java (original)
+++ directory/network/branches/api_integration/src/java/org/apache/mina/common/ByteBuffer.java Mon May 9 08:11:33 2005
@@ -32,6 +32,7 @@
import java.nio.charset.CharsetEncoder;
import java.nio.charset.CoderResult;
+import org.apache.mina.common.IoFilter.NextFilter;
import org.apache.mina.filter.codec.ProtocolEncoderOutput;
import org.apache.mina.util.Stack;
@@ -72,7 +73,8 @@
* <b>Please note that you never need to release the allocated buffer because
* MINA will release it automatically when:
* <ul>
- * <li>You pass the buffer by calling {@link IoSession#write(ByteBuffer, Object)}.</li>
+ * <li>You pass the buffer by calling {@link IoSession#write(Object)}.</li>
+ * <li>You pass the buffer by calling {@link NextFilter#filterWrite(IoSession,Object)}.</li>
* <li>You pass the buffer by calling {@link ProtocolEncoderOutput#write(ByteBuffer)}.</li>
* </ul>
* And, you don't need to release any {@link ByteBuffer} which is passed as a parameter
Modified: directory/network/branches/api_integration/src/java/org/apache/mina/common/DefaultExceptionMonitor.java
URL: http://svn.apache.org/viewcvs/directory/network/branches/api_integration/src/java/org/apache/mina/common/DefaultExceptionMonitor.java?rev=169325&r1=169324&r2=169325&view=diff
==============================================================================
--- directory/network/branches/api_integration/src/java/org/apache/mina/common/DefaultExceptionMonitor.java (original)
+++ directory/network/branches/api_integration/src/java/org/apache/mina/common/DefaultExceptionMonitor.java Mon May 9 08:11:33 2005
@@ -25,7 +25,7 @@
* A default {@link ExceptionMonitor} implementation that logs uncaught
* exceptions using {@link Logger}.
* <p>
- * All {@link SessionManager}s have this implementation as a default exception
+ * All {@link IoSessionManager}s have this implementation as a default exception
* monitor.
*
* @author Trustin Lee (trustin@apache.org)
Modified: directory/network/branches/api_integration/src/java/org/apache/mina/common/IdleStatus.java
URL: http://svn.apache.org/viewcvs/directory/network/branches/api_integration/src/java/org/apache/mina/common/IdleStatus.java?rev=169325&r1=169324&r2=169325&view=diff
==============================================================================
--- directory/network/branches/api_integration/src/java/org/apache/mina/common/IdleStatus.java (original)
+++ directory/network/branches/api_integration/src/java/org/apache/mina/common/IdleStatus.java Mon May 9 08:11:33 2005
@@ -29,7 +29,7 @@
* </ul>
* <p>
* Idle time settings are all disabled by default. You can enable them
- * using {@link SessionConfig#setIdleTime(IdleStatus,int)}.
+ * using {@link IoSessionConfig#setIdleTime(IdleStatus,int)}.
*
* @author Trustin Lee (trustin@apache.org)
* @version $Rev$, $Date$
Modified: directory/network/branches/api_integration/src/java/org/apache/mina/common/IoFilterAdapter.java
URL: http://svn.apache.org/viewcvs/directory/network/branches/api_integration/src/java/org/apache/mina/common/IoFilterAdapter.java?rev=169325&r1=169324&r2=169325&view=diff
==============================================================================
--- directory/network/branches/api_integration/src/java/org/apache/mina/common/IoFilterAdapter.java (original)
+++ directory/network/branches/api_integration/src/java/org/apache/mina/common/IoFilterAdapter.java Mon May 9 08:11:33 2005
@@ -20,7 +20,7 @@
/**
- * An abstract adapter class for {@link ProtocolFilter}. You can extend
+ * An abstract 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.
*
Modified: directory/network/branches/api_integration/src/java/org/apache/mina/common/WriteTimeoutException.java
URL: http://svn.apache.org/viewcvs/directory/network/branches/api_integration/src/java/org/apache/mina/common/WriteTimeoutException.java?rev=169325&r1=169324&r2=169325&view=diff
==============================================================================
--- directory/network/branches/api_integration/src/java/org/apache/mina/common/WriteTimeoutException.java (original)
+++ directory/network/branches/api_integration/src/java/org/apache/mina/common/WriteTimeoutException.java Mon May 9 08:11:33 2005
@@ -22,7 +22,7 @@
/**
* An {@link IOException} which is thrown when write buffer is not flushed for
- * {@link SessionConfig#getWriteTimeout()} seconds.
+ * {@link IoSessionConfig#getWriteTimeout()} seconds.
*
* @author Trustin Lee (trustin@apache.org)
* @version $Rev$, $Date$,
Modified: directory/network/branches/api_integration/src/java/org/apache/mina/filter/ThreadPoolFilter.java
URL: http://svn.apache.org/viewcvs/directory/network/branches/api_integration/src/java/org/apache/mina/filter/ThreadPoolFilter.java?rev=169325&r1=169324&r2=169325&view=diff
==============================================================================
--- directory/network/branches/api_integration/src/java/org/apache/mina/filter/ThreadPoolFilter.java (original)
+++ directory/network/branches/api_integration/src/java/org/apache/mina/filter/ThreadPoolFilter.java Mon May 9 08:11:33 2005
@@ -86,13 +86,10 @@
fireEvent( nextFilter, session, EventType.SENT, message );
}
- protected void processEvent( Object nextFilter0,
- IoSession session0, EventType type,
+ protected void processEvent( NextFilter nextFilter,
+ IoSession session, EventType type,
Object data )
{
- NextFilter nextFilter = ( NextFilter ) nextFilter0;
- IoSession session = ( IoSession ) session0;
-
if( type == EventType.RECEIVED )
{
nextFilter.messageReceived( session, data );
Modified: directory/network/branches/api_integration/src/java/org/apache/mina/filter/codec/MessageDecoderResult.java
URL: http://svn.apache.org/viewcvs/directory/network/branches/api_integration/src/java/org/apache/mina/filter/codec/MessageDecoderResult.java?rev=169325&r1=169324&r2=169325&view=diff
==============================================================================
--- directory/network/branches/api_integration/src/java/org/apache/mina/filter/codec/MessageDecoderResult.java (original)
+++ directory/network/branches/api_integration/src/java/org/apache/mina/filter/codec/MessageDecoderResult.java Mon May 9 08:11:33 2005
@@ -19,6 +19,7 @@
package org.apache.mina.filter.codec;
import org.apache.mina.common.ByteBuffer;
+import org.apache.mina.common.IoSession;
/**
* Represents results from {@link MessageDecoder}.
Modified: directory/network/branches/api_integration/src/java/org/apache/mina/transport/socket/nio/DatagramSessionConfig.java
URL: http://svn.apache.org/viewcvs/directory/network/branches/api_integration/src/java/org/apache/mina/transport/socket/nio/DatagramSessionConfig.java?rev=169325&r1=169324&r2=169325&view=diff
==============================================================================
--- directory/network/branches/api_integration/src/java/org/apache/mina/transport/socket/nio/DatagramSessionConfig.java (original)
+++ directory/network/branches/api_integration/src/java/org/apache/mina/transport/socket/nio/DatagramSessionConfig.java Mon May 9 08:11:33 2005
@@ -23,10 +23,11 @@
import org.apache.mina.common.BaseIoSessionConfig;
import org.apache.mina.common.IoSession;
+import org.apache.mina.common.IoSessionConfig;
/**
- * A {@link SessionConfig} for datagram transport (UDP/IP).
- * You can downcast {@link SessionConfig} instance returned by
+ * A {@link IoSessionConfig} for datagram transport (UDP/IP).
+ * You can downcast {@link IoSessionConfig} instance returned by
* {@link IoSession#getConfig()} or {@link IoSession#getConfig()}
* if you've created datagram session using {@link DatagramAcceptor} or
* {@link DatagramConnector}.
Modified: directory/network/branches/api_integration/src/java/org/apache/mina/transport/socket/nio/SocketSessionConfig.java
URL: http://svn.apache.org/viewcvs/directory/network/branches/api_integration/src/java/org/apache/mina/transport/socket/nio/SocketSessionConfig.java?rev=169325&r1=169324&r2=169325&view=diff
==============================================================================
--- directory/network/branches/api_integration/src/java/org/apache/mina/transport/socket/nio/SocketSessionConfig.java (original)
+++ directory/network/branches/api_integration/src/java/org/apache/mina/transport/socket/nio/SocketSessionConfig.java Mon May 9 08:11:33 2005
@@ -22,10 +22,11 @@
import org.apache.mina.common.BaseIoSessionConfig;
import org.apache.mina.common.IoSession;
+import org.apache.mina.common.IoSessionConfig;
/**
- * A {@link SessionConfig} for socket transport (TCP/IP).
- * You can downcast {@link SessionConfig} instance returned by
+ * A {@link IoSessionConfig} for socket transport (TCP/IP).
+ * You can downcast {@link IoSessionConfig} instance returned by
* {@link IoSession#getConfig()} or {@link IoSession#getConfig()}
* if you've created datagram session using {@link SocketAcceptor} or
* {@link SocketConnector}.
Modified: directory/network/branches/api_integration/src/java/org/apache/mina/transport/vmpipe/VmPipeAcceptor.java
URL: http://svn.apache.org/viewcvs/directory/network/branches/api_integration/src/java/org/apache/mina/transport/vmpipe/VmPipeAcceptor.java?rev=169325&r1=169324&r2=169325&view=diff
==============================================================================
--- directory/network/branches/api_integration/src/java/org/apache/mina/transport/vmpipe/VmPipeAcceptor.java (original)
+++ directory/network/branches/api_integration/src/java/org/apache/mina/transport/vmpipe/VmPipeAcceptor.java Mon May 9 08:11:33 2005
@@ -14,7 +14,7 @@
import org.apache.mina.common.IoHandler;
/**
- * Binds the specified {@link ProtocolProvider} to the specified
+ * Binds the specified {@link IoHandler} to the specified
* {@link VmPipeAddress}.
*
* @author Trustin Lee (trustin@apache.org)
Modified: directory/network/branches/api_integration/src/java/org/apache/mina/transport/vmpipe/VmPipeSessionConfig.java
URL: http://svn.apache.org/viewcvs/directory/network/branches/api_integration/src/java/org/apache/mina/transport/vmpipe/VmPipeSessionConfig.java?rev=169325&r1=169324&r2=169325&view=diff
==============================================================================
--- directory/network/branches/api_integration/src/java/org/apache/mina/transport/vmpipe/VmPipeSessionConfig.java (original)
+++ directory/network/branches/api_integration/src/java/org/apache/mina/transport/vmpipe/VmPipeSessionConfig.java Mon May 9 08:11:33 2005
@@ -4,9 +4,10 @@
package org.apache.mina.transport.vmpipe;
import org.apache.mina.common.BaseIoSessionConfig;
+import org.apache.mina.common.IoSessionConfig;
/**
- * A {@link SessionConfig} for in-VM pipe transport.
+ * A {@link IoSessionConfig} for in-VM pipe transport.
*
* @author Trustin Lee (trustin@apache.org)
* @version $Rev$, $Date$
Modified: directory/network/branches/api_integration/src/java/org/apache/mina/util/BaseThreadPool.java
URL: http://svn.apache.org/viewcvs/directory/network/branches/api_integration/src/java/org/apache/mina/util/BaseThreadPool.java?rev=169325&r1=169324&r2=169325&view=diff
==============================================================================
--- directory/network/branches/api_integration/src/java/org/apache/mina/util/BaseThreadPool.java (original)
+++ directory/network/branches/api_integration/src/java/org/apache/mina/util/BaseThreadPool.java Mon May 9 08:11:33 2005
@@ -25,6 +25,7 @@
import java.util.Set;
import org.apache.mina.common.IoSession;
+import org.apache.mina.common.IoFilter.NextFilter;
/**
* A base implementation of Thread-pooling filters.
@@ -170,7 +171,7 @@
}
}
- protected void fireEvent( Object nextFilter, IoSession session,
+ protected void fireEvent( NextFilter nextFilter, IoSession session,
EventType type, Object data )
{
final BlockingSet readySessionBuffers = this.readySessionBuffers;
@@ -197,7 +198,7 @@
/**
* Implement this method to forward events to <tt>nextFilter</tt>.
*/
- protected abstract void processEvent( Object nextFilter, IoSession session,
+ protected abstract void processEvent( NextFilter nextFilter, IoSession session,
EventType type, Object data );
private SessionBuffer getSessionBuffer( IoSession session )
Modified: directory/network/branches/api_integration/src/java/org/apache/mina/util/Event.java
URL: http://svn.apache.org/viewcvs/directory/network/branches/api_integration/src/java/org/apache/mina/util/Event.java?rev=169325&r1=169324&r2=169325&view=diff
==============================================================================
--- directory/network/branches/api_integration/src/java/org/apache/mina/util/Event.java (original)
+++ directory/network/branches/api_integration/src/java/org/apache/mina/util/Event.java Mon May 9 08:11:33 2005
@@ -18,6 +18,8 @@
*/
package org.apache.mina.util;
+import org.apache.mina.common.IoFilter.NextFilter;
+
/**
* MINA Event used by {@link BaseThreadPool} internally.
*
@@ -28,10 +30,10 @@
class Event
{
private final EventType type;
- private final Object nextFilter;
+ private final NextFilter nextFilter;
private final Object data;
- public Event( EventType type, Object nextFilter, Object data )
+ public Event( EventType type, NextFilter nextFilter, Object data )
{
this.type = type;
this.nextFilter = nextFilter;
@@ -44,7 +46,7 @@
}
- public Object getNextFilter()
+ public NextFilter getNextFilter()
{
return nextFilter;
}
Modified: directory/network/branches/api_integration/src/java/org/apache/mina/util/SessionLog.java
URL: http://svn.apache.org/viewcvs/directory/network/branches/api_integration/src/java/org/apache/mina/util/SessionLog.java?rev=169325&r1=169324&r2=169325&view=diff
==============================================================================
--- directory/network/branches/api_integration/src/java/org/apache/mina/util/SessionLog.java (original)
+++ directory/network/branches/api_integration/src/java/org/apache/mina/util/SessionLog.java Mon May 9 08:11:33 2005
@@ -6,8 +6,8 @@
import org.apache.mina.common.IoSession;
/**
- * Call {@link #getLogger(Session)}, {@link #log(Level,Session, String)}, and
- * {@link #log(Level,Session, String, Throwable)} to log protocol-specific messages.
+ * Call {@link #getLogger(IoSession)}, {@link #log(Level,IoSession, String)}, and
+ * {@link #log(Level,IoSession, String, Throwable)} to log protocol-specific messages.
* <p>
* Set {@link #PREFIX} and {@link #LOGGER} session attributes
* to override prefix string, logger, and log level.
Modified: directory/network/branches/api_integration/src/test/org/apache/mina/common/IoFilterChainTest.java
URL: http://svn.apache.org/viewcvs/directory/network/branches/api_integration/src/test/org/apache/mina/common/IoFilterChainTest.java?rev=169325&r1=169324&r2=169325&view=diff
==============================================================================
--- directory/network/branches/api_integration/src/test/org/apache/mina/common/IoFilterChainTest.java (original)
+++ directory/network/branches/api_integration/src/test/org/apache/mina/common/IoFilterChainTest.java Mon May 9 08:11:33 2005
@@ -24,7 +24,7 @@
import junit.framework.TestCase;
/**
- * Tests {@link AbstractProtocolFilterChain}.
+ * Tests {@link AbstractIoFilterChain}.
*
* @author Trustin Lee (trustin@apache.org)
* @version $Rev$, $Date$
Modified: directory/network/branches/api_integration/src/test/org/apache/mina/examples/echoserver/ConnectorTest.java
URL: http://svn.apache.org/viewcvs/directory/network/branches/api_integration/src/test/org/apache/mina/examples/echoserver/ConnectorTest.java?rev=169325&r1=169324&r2=169325&view=diff
==============================================================================
--- directory/network/branches/api_integration/src/test/org/apache/mina/examples/echoserver/ConnectorTest.java (original)
+++ directory/network/branches/api_integration/src/test/org/apache/mina/examples/echoserver/ConnectorTest.java Mon May 9 08:11:33 2005
@@ -193,7 +193,6 @@
private static class EchoConnectorHandler extends IoHandlerAdapter
{
private ByteBuffer readBuf = ByteBuffer.allocate( 1024 );
- private int counter = 0;
public void messageReceived( IoSession session, Object message )
{