Author: trustin
Date: Fri Nov 9 02:21:35 2007
New Revision: 593479
URL: http://svn.apache.org/viewvc?rev=593479&view=rev
Log:
Fixed JavaDoc errors...
Modified:
mina/trunk/example/src/main/java/org/apache/mina/example/httpclient/Wget.java
mina/trunk/example/src/main/java/org/apache/mina/example/httpserver/codec/HttpRequestDecoder.java
mina/trunk/filter-codec-http/src/main/java/org/apache/mina/filter/codec/http/DateParseException.java
mina/trunk/filter-codec-http/src/main/java/org/apache/mina/filter/codec/http/DateUtil.java
mina/trunk/integration-jmx/src/main/java/org/apache/mina/integration/jmx/IoSessionManager.java
mina/trunk/integration-jmx/src/main/java/org/apache/mina/integration/jmx/IoSessionManagerMBean.java
mina/trunk/integration-spring/src/main/java/org/apache/mina/integration/spring/DefaultIoFilterChainBuilderFactoryBean.java
mina/trunk/integration-spring/src/main/java/org/apache/mina/integration/spring/InetAddressEditor.java
mina/trunk/integration-spring/src/main/java/org/apache/mina/integration/spring/IoFilterMapping.java
mina/trunk/integration-spring/src/main/java/org/apache/mina/integration/spring/ssl/SslContextFactoryBean.java
mina/trunk/statemachine/src/main/java/org/apache/mina/statemachine/context/StateContextLookup.java
mina/trunk/transport-apr/src/main/java/org/apache/mina/transport/socket/apr/AprConnector.java
mina/trunk/transport-apr/src/main/java/org/apache/mina/transport/socket/apr/AprProtocol.java
Modified:
mina/trunk/example/src/main/java/org/apache/mina/example/httpclient/Wget.java
URL:
http://svn.apache.org/viewvc/mina/trunk/example/src/main/java/org/apache/mina/example/httpclient/Wget.java?rev=593479&r1=593478&r2=593479&view=diff
==============================================================================
---
mina/trunk/example/src/main/java/org/apache/mina/example/httpclient/Wget.java
(original)
+++
mina/trunk/example/src/main/java/org/apache/mina/example/httpclient/Wget.java
Fri Nov 9 02:21:35 2007
@@ -148,11 +148,6 @@
message = null;
}
- /**
- * TODO isClosed.
- *
- * @return
- */
public boolean isClosed() {
return closed;
}
Modified:
mina/trunk/example/src/main/java/org/apache/mina/example/httpserver/codec/HttpRequestDecoder.java
URL:
http://svn.apache.org/viewvc/mina/trunk/example/src/main/java/org/apache/mina/example/httpserver/codec/HttpRequestDecoder.java?rev=593479&r1=593478&r2=593479&view=diff
==============================================================================
---
mina/trunk/example/src/main/java/org/apache/mina/example/httpserver/codec/HttpRequestDecoder.java
(original)
+++
mina/trunk/example/src/main/java/org/apache/mina/example/httpserver/codec/HttpRequestDecoder.java
Fri Nov 9 02:21:35 2007
@@ -37,7 +37,7 @@
import org.apache.mina.filter.codec.demux.MessageDecoderResult;
/**
- * A [EMAIL PROTECTED] MessageDecoder} that decodes [EMAIL PROTECTED]
HttpRequest}.
+ * A [EMAIL PROTECTED] MessageDecoder} that decodes [EMAIL PROTECTED]
HttpRequestMessage}.
*
* @author The Apache MINA Project ([EMAIL PROTECTED])
* @version $Rev$, $Date$
Modified:
mina/trunk/filter-codec-http/src/main/java/org/apache/mina/filter/codec/http/DateParseException.java
URL:
http://svn.apache.org/viewvc/mina/trunk/filter-codec-http/src/main/java/org/apache/mina/filter/codec/http/DateParseException.java?rev=593479&r1=593478&r2=593479&view=diff
==============================================================================
---
mina/trunk/filter-codec-http/src/main/java/org/apache/mina/filter/codec/http/DateParseException.java
(original)
+++
mina/trunk/filter-codec-http/src/main/java/org/apache/mina/filter/codec/http/DateParseException.java
Fri Nov 9 02:21:35 2007
@@ -22,8 +22,6 @@
/**
* An exception to indicate an error parsing a date string.
*
- * @see DateUtil
- *
* @author Michael Becke
*/
public class DateParseException extends Exception {
Modified:
mina/trunk/filter-codec-http/src/main/java/org/apache/mina/filter/codec/http/DateUtil.java
URL:
http://svn.apache.org/viewvc/mina/trunk/filter-codec-http/src/main/java/org/apache/mina/filter/codec/http/DateUtil.java?rev=593479&r1=593478&r2=593479&view=diff
==============================================================================
---
mina/trunk/filter-codec-http/src/main/java/org/apache/mina/filter/codec/http/DateUtil.java
(original)
+++
mina/trunk/filter-codec-http/src/main/java/org/apache/mina/filter/codec/http/DateUtil.java
Fri Nov 9 02:21:35 2007
@@ -161,8 +161,6 @@
*
* @param date The date to format.
* @return An RFC 1123 formatted date string.
- *
- * @see #PATTERN_RFC1123
*/
public static String formatDate(Date date) {
return formatDate(date, PATTERN_RFC1123);
Modified:
mina/trunk/integration-jmx/src/main/java/org/apache/mina/integration/jmx/IoSessionManager.java
URL:
http://svn.apache.org/viewvc/mina/trunk/integration-jmx/src/main/java/org/apache/mina/integration/jmx/IoSessionManager.java?rev=593479&r1=593478&r2=593479&view=diff
==============================================================================
---
mina/trunk/integration-jmx/src/main/java/org/apache/mina/integration/jmx/IoSessionManager.java
(original)
+++
mina/trunk/integration-jmx/src/main/java/org/apache/mina/integration/jmx/IoSessionManager.java
Fri Nov 9 02:21:35 2007
@@ -45,23 +45,14 @@
this.session = session;
}
- /**
- * @see archean.util.mina.IoSessionManagerMBean#isConnected()
- */
public boolean isConnected() {
return session.isConnected();
}
- /**
- * @see archean.util.mina.IoSessionManagerMBean#getReadBytes()
- */
public long getReadBytes() {
return session.getReadBytes();
}
- /**
- * @see archean.util.mina.IoSessionManagerMBean#getWrittenBytes()
- */
public long getWrittenBytes() {
return session.getWrittenBytes();
}
@@ -74,44 +65,26 @@
return ((AbstractIoSession) session).getWrittenMessages();
}
- /**
- * @see archean.util.mina.IoSessionManagerMBean#close()
- */
public void close() {
session.close().awaitUninterruptibly();
}
- /**
- * @see archean.util.mina.IoSessionManagerMBean#getCreationTime()
- */
public Date getCreationTime() {
return new Date(session.getCreationTime());
}
- /**
- * @see archean.util.mina.IoSessionManagerMBean#getLastIoTime()
- */
public Date getLastIoTime() {
return new Date(session.getLastIoTime());
}
- /**
- * @see archean.util.mina.IoSessionManagerMBean#getLastReadTime()
- */
public Date getLastReadTime() {
return new Date(session.getLastReadTime());
}
- /**
- * @see archean.util.mina.IoSessionManagerMBean#getLastWriteTime()
- */
public Date getLastWriteTime() {
return new Date(session.getLastWriteTime());
}
- /**
- * @see archean.util.mina.IoSessionManagerMBean#getInstalledFilters()
- */
public String[] getInstalledFilters() {
List<IoFilterChain.Entry> filters = session.getFilterChain().getAll();
String[] res = new String[filters.size()];
@@ -121,32 +94,21 @@
return res;
}
- /**
- * @see archean.util.mina.IoSessionManagerMBean#addLastLoggingFilter()
- */
public void addLastLoggingFilter() {
LoggingFilter f = new LoggingFilter();
session.getFilterChain().addLast("LoggerLast", f);
}
- /**
- * @see archean.util.mina.IoSessionManagerMBean#removeLastLoggingFilter()
- */
public void removeLastLoggingFilter() {
-
session.getFilterChain().remove("LoggerLast");
}
- /**
- * @see archean.util.mina.IoSessionManagerMBean#addFirstLoggingFilter()
- */
public void addFirstLoggingFilter() {
LoggingFilter f = new LoggingFilter();
session.getFilterChain().addFirst("LoggerFirst", f);
}
public void removeFirstLoggingFilter() {
-
session.getFilterChain().remove("LoggerFirst");
}
Modified:
mina/trunk/integration-jmx/src/main/java/org/apache/mina/integration/jmx/IoSessionManagerMBean.java
URL:
http://svn.apache.org/viewvc/mina/trunk/integration-jmx/src/main/java/org/apache/mina/integration/jmx/IoSessionManagerMBean.java?rev=593479&r1=593478&r2=593479&view=diff
==============================================================================
---
mina/trunk/integration-jmx/src/main/java/org/apache/mina/integration/jmx/IoSessionManagerMBean.java
(original)
+++
mina/trunk/integration-jmx/src/main/java/org/apache/mina/integration/jmx/IoSessionManagerMBean.java
Fri Nov 9 02:21:35 2007
@@ -47,14 +47,12 @@
public long getWrittenBytes();
/**
- * PDU decoded from the beginning. Only revelent if a ProtocolCodecFilter
is installed.
- * @return
+ * PDU decoded from the beginning. Only relevant if a ProtocolCodecFilter
is installed.
*/
public long getReadMessages();
/**
- * PDU encoded from the beginning. Only revelent if a ProtocolCodecFilter
is installed.
- * @return
+ * PDU encoded from the beginning. Only relevant if a ProtocolCodecFilter
is installed.
*/
public long getWrittenMessages();
Modified:
mina/trunk/integration-spring/src/main/java/org/apache/mina/integration/spring/DefaultIoFilterChainBuilderFactoryBean.java
URL:
http://svn.apache.org/viewvc/mina/trunk/integration-spring/src/main/java/org/apache/mina/integration/spring/DefaultIoFilterChainBuilderFactoryBean.java?rev=593479&r1=593478&r2=593479&view=diff
==============================================================================
---
mina/trunk/integration-spring/src/main/java/org/apache/mina/integration/spring/DefaultIoFilterChainBuilderFactoryBean.java
(original)
+++
mina/trunk/integration-spring/src/main/java/org/apache/mina/integration/spring/DefaultIoFilterChainBuilderFactoryBean.java
Fri Nov 9 02:21:35 2007
@@ -35,9 +35,8 @@
* <p>
* The filters may be set up in two ways. By creating
* [EMAIL PROTECTED] IoFilterMapping} objects which associate a name with an
[EMAIL PROTECTED] IoFilter}
- * instance and set them using [EMAIL PROTECTED]
#setFilterMappings(IoFilterMapping[])} or
- * by using [EMAIL PROTECTED] #setFilters(IoFilter[])} directly which assigns
automatically
- * generated names to each [EMAIL PROTECTED] IoFilter}. Use the
+ * instance and set them using [EMAIL PROTECTED] #setFilters(List)} directly
which assigns
+ * automatically generated names to each [EMAIL PROTECTED] IoFilter}. Use the
* [EMAIL PROTECTED] #setFilterNamePrefix(String)} method to set the prefix
used for
* auto generated names.
* </p>
@@ -71,7 +70,7 @@
/**
* Sets the prefix used to create the names for automatically named filters
- * added using [EMAIL PROTECTED] #setFilters(IoFilter[])}. The default
prefix is
+ * added using [EMAIL PROTECTED] #setFilters(List)}. The default prefix is
* <tt>filter</tt>.
*
* @param prefix the prefix.
Modified:
mina/trunk/integration-spring/src/main/java/org/apache/mina/integration/spring/InetAddressEditor.java
URL:
http://svn.apache.org/viewvc/mina/trunk/integration-spring/src/main/java/org/apache/mina/integration/spring/InetAddressEditor.java?rev=593479&r1=593478&r2=593479&view=diff
==============================================================================
---
mina/trunk/integration-spring/src/main/java/org/apache/mina/integration/spring/InetAddressEditor.java
(original)
+++
mina/trunk/integration-spring/src/main/java/org/apache/mina/integration/spring/InetAddressEditor.java
Fri Nov 9 02:21:35 2007
@@ -23,11 +23,13 @@
import java.net.InetAddress;
import java.net.UnknownHostException;
+import org.apache.mina.filter.firewall.BlacklistFilter;
+
/**
* Java Bean [EMAIL PROTECTED] java.beans.PropertyEditor} which converts
Strings into
* [EMAIL PROTECTED] InetAddress} objects. This may be used together with
Spring to be able
* to set [EMAIL PROTECTED] InetAddress} bean properties, e.g.
- * [EMAIL PROTECTED]
org.apache.mina.filter.BlacklistFilter#setBlacklist(InetAddress[])}.
+ * [EMAIL PROTECTED] BlacklistFilter#setBlacklist(InetAddress[])}.
* Simply calls [EMAIL PROTECTED] InetAddress#getByName(java.lang.String)} when
* converting from a String.
* <p>
Modified:
mina/trunk/integration-spring/src/main/java/org/apache/mina/integration/spring/IoFilterMapping.java
URL:
http://svn.apache.org/viewvc/mina/trunk/integration-spring/src/main/java/org/apache/mina/integration/spring/IoFilterMapping.java?rev=593479&r1=593478&r2=593479&view=diff
==============================================================================
---
mina/trunk/integration-spring/src/main/java/org/apache/mina/integration/spring/IoFilterMapping.java
(original)
+++
mina/trunk/integration-spring/src/main/java/org/apache/mina/integration/spring/IoFilterMapping.java
Fri Nov 9 02:21:35 2007
@@ -20,6 +20,7 @@
package org.apache.mina.integration.spring;
import org.apache.mina.common.IoFilter;
+import org.apache.mina.common.IoService;
import org.springframework.beans.factory.InitializingBean;
import org.springframework.util.Assert;
@@ -29,24 +30,11 @@
* <p>
* Use this class when you want to configure the
* filters added to the filter chain of all sessions created from a particular
- * [EMAIL PROTECTED] org.apache.mina.common.IoService} created using one of the
- * [EMAIL PROTECTED] org.apache.mina.integration.spring.IoAcceptorFactoryBean}
- * sub-classes but you don't want the names to be generated automatically.
- * </p>
- * <p>
- * This class can also be used when creating [EMAIL PROTECTED] Binding}
objects. This lets
- * one configure per-port filters. These filters will only be added to the
- * filter chain of sessions for incoming connections on the port specified by
- * the [EMAIL PROTECTED] Binding}. Note that [EMAIL PROTECTED] Binding} can
also be configured to
- * generate filter names automatically. In that case you add the [EMAIL
PROTECTED] IoFilter}
- * instances directly to the [EMAIL PROTECTED] Binding}.
+ * [EMAIL PROTECTED] IoService} created, but you don't want the names to be
generated automatically.
* </p>
*
* @author The Apache MINA Project ([EMAIL PROTECTED])
* @version $Rev$, $Date$
- *
- * @see org.apache.mina.integration.spring.IoAcceptorFactoryBean
- * @see org.apache.mina.integration.spring.Binding
*/
public class IoFilterMapping implements InitializingBean {
private String name = null;
Modified:
mina/trunk/integration-spring/src/main/java/org/apache/mina/integration/spring/ssl/SslContextFactoryBean.java
URL:
http://svn.apache.org/viewvc/mina/trunk/integration-spring/src/main/java/org/apache/mina/integration/spring/ssl/SslContextFactoryBean.java?rev=593479&r1=593478&r2=593479&view=diff
==============================================================================
---
mina/trunk/integration-spring/src/main/java/org/apache/mina/integration/spring/ssl/SslContextFactoryBean.java
(original)
+++
mina/trunk/integration-spring/src/main/java/org/apache/mina/integration/spring/ssl/SslContextFactoryBean.java
Fri Nov 9 02:21:35 2007
@@ -421,8 +421,8 @@
/**
* Sets the SSLSession cache size for the [EMAIL PROTECTED]
SSLSessionContext} for use in server mode.
*
- * @param size the new session cache size limit; zero means there is no
limit.
- * @see SSLSessionContext#setSessionCacheSize(int size)
+ * @param serverSessionCacheSize the new session cache size limit; zero
means there is no limit.
+ * @see SSLSessionContext#setSessionCacheSize(int)
*/
public void setServerSessionCacheSize(int serverSessionCacheSize) {
this.serverSessionCacheSize = serverSessionCacheSize;
@@ -431,8 +431,8 @@
/**
* Set the SSLSession timeout limit for the [EMAIL PROTECTED]
SSLSessionContext} for use in server mode.
*
- * @param seconds the new session timeout limit in seconds; zero means
there is no limit.
- * @see SSLSessionContext#setSessionTimeout(int seconds)
+ * @param serverSessionTimeout the new session timeout limit in seconds;
zero means there is no limit.
+ * @see SSLSessionContext#setSessionTimeout(int)
*/
public void setServerSessionTimeout(int serverSessionTimeout) {
this.serverSessionTimeout = serverSessionTimeout;
Modified:
mina/trunk/statemachine/src/main/java/org/apache/mina/statemachine/context/StateContextLookup.java
URL:
http://svn.apache.org/viewvc/mina/trunk/statemachine/src/main/java/org/apache/mina/statemachine/context/StateContextLookup.java?rev=593479&r1=593478&r2=593479&view=diff
==============================================================================
---
mina/trunk/statemachine/src/main/java/org/apache/mina/statemachine/context/StateContextLookup.java
(original)
+++
mina/trunk/statemachine/src/main/java/org/apache/mina/statemachine/context/StateContextLookup.java
Fri Nov 9 02:21:35 2007
@@ -34,9 +34,6 @@
* must create a new [EMAIL PROTECTED] StateContext} if a compatible
object is in
* the arguments and the next time that same object is passed to this
* method the same [EMAIL PROTECTED] StateContext} should be returned.
- *
- * @param eventArgs
- * @return
*/
StateContext lookup(Object[] eventArgs);
}
Modified:
mina/trunk/transport-apr/src/main/java/org/apache/mina/transport/socket/apr/AprConnector.java
URL:
http://svn.apache.org/viewvc/mina/trunk/transport-apr/src/main/java/org/apache/mina/transport/socket/apr/AprConnector.java?rev=593479&r1=593478&r2=593479&view=diff
==============================================================================
---
mina/trunk/transport-apr/src/main/java/org/apache/mina/transport/socket/apr/AprConnector.java
(original)
+++
mina/trunk/transport-apr/src/main/java/org/apache/mina/transport/socket/apr/AprConnector.java
Fri Nov 9 02:21:35 2007
@@ -78,10 +78,6 @@
*
* @param protocol
* The needed socket protocol (TCP,UDP,...)
- * @param processorCount
- * Number of processing threads
- * @param executor
- * Executor to use for launching threads
*/
public AprConnector(AprProtocol protocol, IoProcessor<AprSession>
processor, boolean createdProcessor) {
super(new DefaultAprSessionConfig());
Modified:
mina/trunk/transport-apr/src/main/java/org/apache/mina/transport/socket/apr/AprProtocol.java
URL:
http://svn.apache.org/viewvc/mina/trunk/transport-apr/src/main/java/org/apache/mina/transport/socket/apr/AprProtocol.java?rev=593479&r1=593478&r2=593479&view=diff
==============================================================================
---
mina/trunk/transport-apr/src/main/java/org/apache/mina/transport/socket/apr/AprProtocol.java
(original)
+++
mina/trunk/transport-apr/src/main/java/org/apache/mina/transport/socket/apr/AprProtocol.java
Fri Nov 9 02:21:35 2007
@@ -27,7 +27,7 @@
* @author The Apache MINA Project ([EMAIL PROTECTED])
* @version $Rev$, $Date$
*/
-enum AprProtocol {
+public enum AprProtocol {
TCP(Socket.APR_PROTO_TCP,Socket.SOCK_STREAM),
UDP(Socket.APR_PROTO_UDP,Socket.SOCK_DGRAM),
SCTP(Socket.APR_PROTO_SCTP,Socket.SOCK_STREAM);