Author: trustin
Date: Fri Nov 9 02:14:12 2007
New Revision: 593474
URL: http://svn.apache.org/viewvc?rev=593474&view=rev
Log:
Fixed JavaDoc errors
Modified:
mina/trunk/core/src/main/java/org/apache/mina/common/DefaultIoFilterChainBuilder.java
mina/trunk/core/src/main/java/org/apache/mina/common/IdleStatus.java
mina/trunk/core/src/main/java/org/apache/mina/common/IoBuffer.java
mina/trunk/core/src/main/java/org/apache/mina/common/IoFilterChain.java
mina/trunk/core/src/main/java/org/apache/mina/common/IoService.java
mina/trunk/core/src/main/java/org/apache/mina/filter/codec/demux/DemuxingProtocolDecoder.java
mina/trunk/core/src/main/java/org/apache/mina/filter/codec/textline/TextLineCodecFactory.java
mina/trunk/core/src/main/java/org/apache/mina/filter/logging/LoggingFilter.java
mina/trunk/core/src/main/java/org/apache/mina/filter/reqres/RequestResponseFilter.java
mina/trunk/core/src/main/java/org/apache/mina/filter/statistic/ProfilerTimerFilter.java
mina/trunk/core/src/main/java/org/apache/mina/filter/traffic/ReadThrottleFilter.java
mina/trunk/core/src/main/java/org/apache/mina/filter/traffic/ReadThrottlePolicy.java
mina/trunk/core/src/main/java/org/apache/mina/filter/traffic/WriteThrottlePolicy.java
mina/trunk/core/src/main/java/org/apache/mina/util/CopyOnWriteMap.java
mina/trunk/core/src/test/java/org/apache/mina/transport/socket/nio/DatagramBindTest.java
mina/trunk/core/src/test/java/org/apache/mina/transport/socket/nio/DatagramConfigTest.java
mina/trunk/core/src/test/java/org/apache/mina/transport/socket/nio/DatagramConnectorTest.java
Modified:
mina/trunk/core/src/main/java/org/apache/mina/common/DefaultIoFilterChainBuilder.java
URL:
http://svn.apache.org/viewvc/mina/trunk/core/src/main/java/org/apache/mina/common/DefaultIoFilterChainBuilder.java?rev=593474&r1=593473&r2=593474&view=diff
==============================================================================
---
mina/trunk/core/src/main/java/org/apache/mina/common/DefaultIoFilterChainBuilder.java
(original)
+++
mina/trunk/core/src/main/java/org/apache/mina/common/DefaultIoFilterChainBuilder.java
Fri Nov 9 02:14:12 2007
@@ -63,7 +63,7 @@
}
/**
- * Creates a new copy of the specified [EMAIL PROTECTED]
DefaultFilterChainBuilder}.
+ * Creates a new copy of the specified [EMAIL PROTECTED]
DefaultIoFilterChainBuilder}.
*/
public DefaultIoFilterChainBuilder(DefaultIoFilterChainBuilder
filterChain) {
if (filterChain == null) {
Modified: mina/trunk/core/src/main/java/org/apache/mina/common/IdleStatus.java
URL:
http://svn.apache.org/viewvc/mina/trunk/core/src/main/java/org/apache/mina/common/IdleStatus.java?rev=593474&r1=593473&r2=593474&view=diff
==============================================================================
--- mina/trunk/core/src/main/java/org/apache/mina/common/IdleStatus.java
(original)
+++ mina/trunk/core/src/main/java/org/apache/mina/common/IdleStatus.java Fri
Nov 9 02:14:12 2007
@@ -29,7 +29,7 @@
* </ul>
* <p>
* Idle time settings are all disabled by default. You can enable them
- * using [EMAIL PROTECTED] IoSession#setIdleTime(IdleStatus,int)}.
+ * using [EMAIL PROTECTED] IoSessionConfig#setIdleTime(IdleStatus,int)}.
*
* @author The Apache MINA Project ([EMAIL PROTECTED])
* @version $Rev$, $Date$
Modified: mina/trunk/core/src/main/java/org/apache/mina/common/IoBuffer.java
URL:
http://svn.apache.org/viewvc/mina/trunk/core/src/main/java/org/apache/mina/common/IoBuffer.java?rev=593474&r1=593473&r2=593474&view=diff
==============================================================================
--- mina/trunk/core/src/main/java/org/apache/mina/common/IoBuffer.java
(original)
+++ mina/trunk/core/src/main/java/org/apache/mina/common/IoBuffer.java Fri Nov
9 02:14:12 2007
@@ -1918,7 +1918,6 @@
*
* @param <E> The enum type to return
* @param enumClass The enum's class object
- * @return
*/
public <E extends Enum<E>> E getEnum(Class<E> enumClass) {
return toEnum(enumClass, get());
@@ -1931,7 +1930,6 @@
* @param <E> The enum type to return
* @param index the index from which the byte will be read
* @param enumClass The enum's class object
- * @return
*/
public <E extends Enum<E>> E getEnum(int index, Class<E> enumClass) {
return toEnum(enumClass, get(index));
@@ -1943,7 +1941,6 @@
*
* @param <E> The enum type to return
* @param enumClass The enum's class object
- * @return
*/
public <E extends Enum<E>> E getEnumShort(Class<E> enumClass) {
return toEnum(enumClass, getShort());
@@ -1956,7 +1953,6 @@
* @param <E> The enum type to return
* @param index the index from which the bytes will be read
* @param enumClass The enum's class object
- * @return
*/
public <E extends Enum<E>> E getEnumShort(int index, Class<E> enumClass) {
return toEnum(enumClass, getShort(index));
@@ -1968,7 +1964,6 @@
*
* @param <E> The enum type to return
* @param enumClass The enum's class object
- * @return
*/
public <E extends Enum<E>> E getEnumInt(Class<E> enumClass) {
return toEnum(enumClass, getInt());
@@ -1981,7 +1976,6 @@
* @param <E> The enum type to return
* @param index the index from which the bytes will be read
* @param enumClass The enum's class object
- * @return
*/
public <E extends Enum<E>> E getEnumInt(int index, Class<E> enumClass) {
return toEnum(enumClass, getInt(index));
Modified:
mina/trunk/core/src/main/java/org/apache/mina/common/IoFilterChain.java
URL:
http://svn.apache.org/viewvc/mina/trunk/core/src/main/java/org/apache/mina/common/IoFilterChain.java?rev=593474&r1=593473&r2=593474&view=diff
==============================================================================
--- mina/trunk/core/src/main/java/org/apache/mina/common/IoFilterChain.java
(original)
+++ mina/trunk/core/src/main/java/org/apache/mina/common/IoFilterChain.java Fri
Nov 9 02:14:12 2007
@@ -325,7 +325,6 @@
/**
* Replace the filter of this entry with the specified new filter.
*
- * @return the old filter
* @throws IllegalArgumentException if there's no such filter
*/
void replace(IoFilter newFilter);
Modified: mina/trunk/core/src/main/java/org/apache/mina/common/IoService.java
URL:
http://svn.apache.org/viewvc/mina/trunk/core/src/main/java/org/apache/mina/common/IoService.java?rev=593474&r1=593473&r2=593474&view=diff
==============================================================================
--- mina/trunk/core/src/main/java/org/apache/mina/common/IoService.java
(original)
+++ mina/trunk/core/src/main/java/org/apache/mina/common/IoService.java Fri Nov
9 02:14:12 2007
@@ -19,6 +19,7 @@
*/
package org.apache.mina.common;
+import java.util.Collection;
import java.util.Set;
/**
@@ -178,7 +179,7 @@
/**
* Writes the specified [EMAIL PROTECTED] message} to all the [EMAIL
PROTECTED] IoSession}s
* managed by this service. This method is a convenience shortcut for
- * [EMAIL PROTECTED] IoSessions#broadcast(Object, java.util.Collection)}.
+ * [EMAIL PROTECTED] IoUtil#broadcast(Object, Collection)}.
*/
Set<WriteFuture> broadcast(Object message);
Modified:
mina/trunk/core/src/main/java/org/apache/mina/filter/codec/demux/DemuxingProtocolDecoder.java
URL:
http://svn.apache.org/viewvc/mina/trunk/core/src/main/java/org/apache/mina/filter/codec/demux/DemuxingProtocolDecoder.java?rev=593474&r1=593473&r2=593474&view=diff
==============================================================================
---
mina/trunk/core/src/main/java/org/apache/mina/filter/codec/demux/DemuxingProtocolDecoder.java
(original)
+++
mina/trunk/core/src/main/java/org/apache/mina/filter/codec/demux/DemuxingProtocolDecoder.java
Fri Nov 9 02:14:12 2007
@@ -23,11 +23,12 @@
import org.apache.mina.common.IoBuffer;
import org.apache.mina.common.IoSession;
import org.apache.mina.filter.codec.CumulativeProtocolDecoder;
+import org.apache.mina.filter.codec.ProtocolDecoder;
import org.apache.mina.filter.codec.ProtocolDecoderException;
import org.apache.mina.filter.codec.ProtocolDecoderOutput;
/**
- * A composite [EMAIL PROTECTED] ProtocoDecoder} that demultiplexes incoming
[EMAIL PROTECTED] IoBuffer}
+ * A composite [EMAIL PROTECTED] ProtocolDecoder} that demultiplexes incoming
[EMAIL PROTECTED] IoBuffer}
* decoding requests into an appropriate [EMAIL PROTECTED] MessageDecoder}.
*
* <h2>Internal mechanism of [EMAIL PROTECTED] MessageDecoder} selection</h2>
Modified:
mina/trunk/core/src/main/java/org/apache/mina/filter/codec/textline/TextLineCodecFactory.java
URL:
http://svn.apache.org/viewvc/mina/trunk/core/src/main/java/org/apache/mina/filter/codec/textline/TextLineCodecFactory.java?rev=593474&r1=593473&r2=593474&view=diff
==============================================================================
---
mina/trunk/core/src/main/java/org/apache/mina/filter/codec/textline/TextLineCodecFactory.java
(original)
+++
mina/trunk/core/src/main/java/org/apache/mina/filter/codec/textline/TextLineCodecFactory.java
Fri Nov 9 02:14:12 2007
@@ -48,8 +48,8 @@
/**
* Creates a new instance with the specified [EMAIL PROTECTED] Charset}.
The
- * encoder uses a UNIX [EMAIL PROTECTED] LineDelimeter} and the decoder
uses
- * the AUTO [EMAIL PROTECTED] LineDelimeter}.
+ * encoder uses a UNIX [EMAIL PROTECTED] LineDelimiter} and the decoder
uses
+ * the AUTO [EMAIL PROTECTED] LineDelimiter}.
*
* @param charset
* The charset to use in the encoding and decoding
Modified:
mina/trunk/core/src/main/java/org/apache/mina/filter/logging/LoggingFilter.java
URL:
http://svn.apache.org/viewvc/mina/trunk/core/src/main/java/org/apache/mina/filter/logging/LoggingFilter.java?rev=593474&r1=593473&r2=593474&view=diff
==============================================================================
---
mina/trunk/core/src/main/java/org/apache/mina/filter/logging/LoggingFilter.java
(original)
+++
mina/trunk/core/src/main/java/org/apache/mina/filter/logging/LoggingFilter.java
Fri Nov 9 02:14:12 2007
@@ -23,6 +23,7 @@
import org.apache.mina.common.IdleStatus;
import org.apache.mina.common.IoEventType;
+import org.apache.mina.common.IoFilter;
import org.apache.mina.common.IoFilterAdapter;
import org.apache.mina.common.IoSession;
import org.apache.mina.common.IoSessionLogger;
@@ -37,8 +38,9 @@
* are in place that allow the user to use either the get or set method for
each event
* and pass in the [EMAIL PROTECTED] IoEventType} and the [EMAIL PROTECTED]
LogLevel}.
*
- * By default, all events are logged to the [EMAIL PROTECTED]
IoEventType.INFO} level except
- * [EMAIL PROTECTED] IoFilterAdapter.exceptionCaught()}, which is logged to
[EMAIL PROTECTED] IoEventType.WARN}.
+ * By default, all events are logged to the [EMAIL PROTECTED] #INFO} level
except
+ * [EMAIL PROTECTED] IoFilterAdapter#exceptionCaught(IoFilter.NextFilter,
IoSession, Throwable)},
+ * which is logged to [EMAIL PROTECTED] #WARN}.
*
* @author <a href="mailto:[EMAIL PROTECTED]">Apache Directory Project</a>
* @version $Rev$, $Date$
Modified:
mina/trunk/core/src/main/java/org/apache/mina/filter/reqres/RequestResponseFilter.java
URL:
http://svn.apache.org/viewvc/mina/trunk/core/src/main/java/org/apache/mina/filter/reqres/RequestResponseFilter.java?rev=593474&r1=593473&r2=593474&view=diff
==============================================================================
---
mina/trunk/core/src/main/java/org/apache/mina/filter/reqres/RequestResponseFilter.java
(original)
+++
mina/trunk/core/src/main/java/org/apache/mina/filter/reqres/RequestResponseFilter.java
Fri Nov 9 02:14:12 2007
@@ -320,7 +320,7 @@
* [EMAIL PROTECTED] #createUnrespondedRequestStore(IoSession)}. This
method is
* useful if you override [EMAIL PROTECTED]
#createUnrespondedRequestStore(IoSession)}.
*
- * @param requestStore what you returned in [EMAIL PROTECTED]
#createUnrespondedRequestStore(IoSession)}
+ * @param unrespondedRequestStore what you returned in [EMAIL PROTECTED]
#createUnrespondedRequestStore(IoSession)}
*/
protected void destroyUnrespondedRequestStore(
@SuppressWarnings("unused")
Modified:
mina/trunk/core/src/main/java/org/apache/mina/filter/statistic/ProfilerTimerFilter.java
URL:
http://svn.apache.org/viewvc/mina/trunk/core/src/main/java/org/apache/mina/filter/statistic/ProfilerTimerFilter.java?rev=593474&r1=593473&r2=593474&view=diff
==============================================================================
---
mina/trunk/core/src/main/java/org/apache/mina/filter/statistic/ProfilerTimerFilter.java
(original)
+++
mina/trunk/core/src/main/java/org/apache/mina/filter/statistic/ProfilerTimerFilter.java
Fri Nov 9 02:14:12 2007
@@ -93,10 +93,9 @@
}
/**
- * Sets the [EMAIL PROTECTED] ProfilerTimerUnit} being used.
+ * Sets the [EMAIL PROTECTED] TimeUnit} being used.
*
- * @param timeUnit
- * Sets the new [EMAIL PROTECTED] ProfilerTimerUnit} to be used.
+ * @param unit the new [EMAIL PROTECTED] TimeUnit} to be used.
*/
public void setTimeUnit(TimeUnit unit) {
if (unit == TimeUnit.MILLISECONDS) {
@@ -147,7 +146,7 @@
* Set the bitmask in order to tell this filter which
* methods to print out timing information
*
- * @param eventsToProfile
+ * @param methodsToLog
* An int representing the new methods that should be logged
*/
public void setEventsToProfile(EnumSet<IoEventType> methodsToLog) {
@@ -326,7 +325,7 @@
* for each method.
*
*/
- class TimerWorker {
+ private class TimerWorker {
private AtomicLong total;
@@ -424,7 +423,7 @@
}
}
- enum ProfilerTimerUnit {
+ private enum ProfilerTimerUnit {
SECONDS {
@Override
public long timeNow() {
Modified:
mina/trunk/core/src/main/java/org/apache/mina/filter/traffic/ReadThrottleFilter.java
URL:
http://svn.apache.org/viewvc/mina/trunk/core/src/main/java/org/apache/mina/filter/traffic/ReadThrottleFilter.java?rev=593474&r1=593473&r2=593474&view=diff
==============================================================================
---
mina/trunk/core/src/main/java/org/apache/mina/filter/traffic/ReadThrottleFilter.java
(original)
+++
mina/trunk/core/src/main/java/org/apache/mina/filter/traffic/ReadThrottleFilter.java
Fri Nov 9 02:14:12 2007
@@ -68,7 +68,7 @@
private static long lastGlobalResumeTime = 0;
/**
- * Returns the current amount of data in the buffer of the [EMAIL
PROTECTED] ExecuorFilter}
+ * Returns the current amount of data in the buffer of the [EMAIL
PROTECTED] ExecutorFilter}
* for all [EMAIL PROTECTED] IoSession} whose [EMAIL PROTECTED]
IoFilterChain} has been configured by
* this builder.
*/
Modified:
mina/trunk/core/src/main/java/org/apache/mina/filter/traffic/ReadThrottlePolicy.java
URL:
http://svn.apache.org/viewvc/mina/trunk/core/src/main/java/org/apache/mina/filter/traffic/ReadThrottlePolicy.java?rev=593474&r1=593473&r2=593474&view=diff
==============================================================================
---
mina/trunk/core/src/main/java/org/apache/mina/filter/traffic/ReadThrottlePolicy.java
(original)
+++
mina/trunk/core/src/main/java/org/apache/mina/filter/traffic/ReadThrottlePolicy.java
Fri Nov 9 02:14:12 2007
@@ -41,7 +41,7 @@
/**
* Block the write operation until the size of write request buffer
* is full. You must use this policy in conjunction with the
- * [EMAIL PROTECTED] ReadThrottleFilterChainBuilder} to prevent the
+ * [EMAIL PROTECTED] ReadThrottleFilter} to prevent the
* [EMAIL PROTECTED] OutOfMemoryError} on the reader side.
*/
BLOCK,
Modified:
mina/trunk/core/src/main/java/org/apache/mina/filter/traffic/WriteThrottlePolicy.java
URL:
http://svn.apache.org/viewvc/mina/trunk/core/src/main/java/org/apache/mina/filter/traffic/WriteThrottlePolicy.java?rev=593474&r1=593473&r2=593474&view=diff
==============================================================================
---
mina/trunk/core/src/main/java/org/apache/mina/filter/traffic/WriteThrottlePolicy.java
(original)
+++
mina/trunk/core/src/main/java/org/apache/mina/filter/traffic/WriteThrottlePolicy.java
Fri Nov 9 02:14:12 2007
@@ -42,7 +42,7 @@
/**
* Block the write operation until the size of write request buffer
* is full. You must use this policy in conjunction with the
- * [EMAIL PROTECTED] ReadThrottleFilterChainBuilder} to prevent the
+ * [EMAIL PROTECTED] WriteThrottleFilter} to prevent the
* [EMAIL PROTECTED] OutOfMemoryError} on the reader side.
*/
BLOCK,
Modified: mina/trunk/core/src/main/java/org/apache/mina/util/CopyOnWriteMap.java
URL:
http://svn.apache.org/viewvc/mina/trunk/core/src/main/java/org/apache/mina/util/CopyOnWriteMap.java?rev=593474&r1=593473&r2=593474&view=diff
==============================================================================
--- mina/trunk/core/src/main/java/org/apache/mina/util/CopyOnWriteMap.java
(original)
+++ mina/trunk/core/src/main/java/org/apache/mina/util/CopyOnWriteMap.java Fri
Nov 9 02:14:12 2007
@@ -62,7 +62,7 @@
* initial data being held by this map is contained in
* the supplied map.
*
- * @param internalMap
+ * @param data
* A Map containing the initial contents to be placed into
* this class.
*/
Modified:
mina/trunk/core/src/test/java/org/apache/mina/transport/socket/nio/DatagramBindTest.java
URL:
http://svn.apache.org/viewvc/mina/trunk/core/src/test/java/org/apache/mina/transport/socket/nio/DatagramBindTest.java?rev=593474&r1=593473&r2=593474&view=diff
==============================================================================
---
mina/trunk/core/src/test/java/org/apache/mina/transport/socket/nio/DatagramBindTest.java
(original)
+++
mina/trunk/core/src/test/java/org/apache/mina/transport/socket/nio/DatagramBindTest.java
Fri Nov 9 02:14:12 2007
@@ -26,7 +26,7 @@
import org.apache.mina.transport.AbstractBindTest;
/**
- * Tests [EMAIL PROTECTED] NIODatagramAcceptor} resource leakage.
+ * Tests [EMAIL PROTECTED] NioDatagramAcceptor} resource leakage.
*
* @author The Apache MINA Project ([EMAIL PROTECTED])
* @version $Rev$, $Date$
Modified:
mina/trunk/core/src/test/java/org/apache/mina/transport/socket/nio/DatagramConfigTest.java
URL:
http://svn.apache.org/viewvc/mina/trunk/core/src/test/java/org/apache/mina/transport/socket/nio/DatagramConfigTest.java?rev=593474&r1=593473&r2=593474&view=diff
==============================================================================
---
mina/trunk/core/src/test/java/org/apache/mina/transport/socket/nio/DatagramConfigTest.java
(original)
+++
mina/trunk/core/src/test/java/org/apache/mina/transport/socket/nio/DatagramConfigTest.java
Fri Nov 9 02:14:12 2007
@@ -37,7 +37,7 @@
import org.apache.mina.util.AvailablePortFinder;
/**
- * Tests if [EMAIL PROTECTED] NIODatagramAcceptor} session is configured
properly.
+ * Tests if [EMAIL PROTECTED] NioDatagramAcceptor} session is configured
properly.
*
* @author The Apache MINA Project ([EMAIL PROTECTED])
* @version $Rev$, $Date$
Modified:
mina/trunk/core/src/test/java/org/apache/mina/transport/socket/nio/DatagramConnectorTest.java
URL:
http://svn.apache.org/viewvc/mina/trunk/core/src/test/java/org/apache/mina/transport/socket/nio/DatagramConnectorTest.java?rev=593474&r1=593473&r2=593474&view=diff
==============================================================================
---
mina/trunk/core/src/test/java/org/apache/mina/transport/socket/nio/DatagramConnectorTest.java
(original)
+++
mina/trunk/core/src/test/java/org/apache/mina/transport/socket/nio/DatagramConnectorTest.java
Fri Nov 9 02:14:12 2007
@@ -24,7 +24,7 @@
import org.apache.mina.transport.AbstractConnectorTest;
/**
- * Tests [EMAIL PROTECTED] NIODatagramConnector}.
+ * Tests [EMAIL PROTECTED] NioDatagramConnector}.
*
* @author The Apache MINA Project ([EMAIL PROTECTED])
* @version $Rev$, $Date$
