Repository: mina Updated Branches: refs/heads/2.0 dfbf50712 -> 300782fcf
Fixed all the MINA sub-projects (but core) Javadoc errors Project: http://git-wip-us.apache.org/repos/asf/mina/repo Commit: http://git-wip-us.apache.org/repos/asf/mina/commit/300782fc Tree: http://git-wip-us.apache.org/repos/asf/mina/tree/300782fc Diff: http://git-wip-us.apache.org/repos/asf/mina/diff/300782fc Branch: refs/heads/2.0 Commit: 300782fcfef8b7e8aa7a16dd98e7b56c2f6326a3 Parents: dfbf507 Author: Emmanuel Lécharny <[email protected]> Authored: Fri Jan 22 13:01:39 2016 +0100 Committer: Emmanuel Lécharny <[email protected]> Committed: Fri Jan 22 13:01:39 2016 +0100 ---------------------------------------------------------------------- .../echoserver/ssl/BogusSslContextFactory.java | 6 ++-- .../timeserver/MinaTimeServer.java | 3 ++ .../example/proxy/AbstractProxyIoHandler.java | 9 +++++ .../sumup/codec/AbstractMessageDecoder.java | 2 ++ .../apache/mina/example/tcp/perf/TcpClient.java | 4 +-- .../apache/mina/example/tcp/perf/TcpServer.java | 7 ++++ .../apache/mina/example/tennis/TennisBall.java | 8 +++-- .../apache/mina/example/udp/perf/UdpClient.java | 5 +-- .../apache/mina/example/udp/perf/UdpServer.java | 5 +++ .../filter/compression/CompressionFilter.java | 8 +++-- .../org/apache/mina/http/api/HttpMessage.java | 7 ++-- .../org/apache/mina/http/api/HttpRequest.java | 2 +- .../org/apache/mina/http/api/HttpVersion.java | 1 + .../mina/integration/jmx/ObjectMBean.java | 2 ++ .../mina/integration/ognl/IoSessionFinder.java | 10 ++++++ .../integration/xbean/SocketAddressFactory.java | 5 +++ .../org/apache/mina/statemachine/State.java | 37 +++++++++++--------- .../apache/mina/statemachine/StateMachine.java | 4 +-- .../statemachine/StateMachineProxyBuilder.java | 1 + .../annotation/IoFilterTransition.java | 8 ++--- .../annotation/IoHandlerTransition.java | 8 ++--- .../mina/statemachine/annotation/OnEntry.java | 2 ++ .../mina/statemachine/annotation/OnExit.java | 2 ++ .../mina/statemachine/annotation/State.java | 2 ++ .../statemachine/annotation/Transition.java | 8 +++++ .../mina/statemachine/context/StateContext.java | 4 +-- .../context/StateContextLookup.java | 3 ++ .../apache/mina/statemachine/event/Event.java | 12 ++----- .../event/UnhandledEventException.java | 4 +-- .../transition/AbstractSelfTransition.java | 8 +++-- .../transition/MethodSelfTransition.java | 4 +-- .../transition/MethodTransition.java | 6 +--- .../statemachine/transition/SelfTransition.java | 7 ++-- .../statemachine/transition/Transition.java | 8 ++--- .../transport/socket/apr/AprSocketAcceptor.java | 2 ++ .../mina/transport/serial/SerialSession.java | 5 +-- .../transport/serial/SerialSessionConfig.java | 8 ++--- 37 files changed, 142 insertions(+), 85 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/mina/blob/300782fc/mina-example/src/main/java/org/apache/mina/example/echoserver/ssl/BogusSslContextFactory.java ---------------------------------------------------------------------- diff --git a/mina-example/src/main/java/org/apache/mina/example/echoserver/ssl/BogusSslContextFactory.java b/mina-example/src/main/java/org/apache/mina/example/echoserver/ssl/BogusSslContextFactory.java index 8b1b6fe..cab7d8c 100644 --- a/mina-example/src/main/java/org/apache/mina/example/echoserver/ssl/BogusSslContextFactory.java +++ b/mina-example/src/main/java/org/apache/mina/example/echoserver/ssl/BogusSslContextFactory.java @@ -75,9 +75,9 @@ public class BogusSslContextFactory { /** * Get SSLContext singleton. * - * @return SSLContext - * @throws java.security.GeneralSecurityException - * + * @param server A flag to tell if this is a Client or Server instance we want to create + * @return SSLContext The created SSLContext + * @throws GeneralSecurityException If we had an issue creating the SSLContext */ public static SSLContext getInstance(boolean server) throws GeneralSecurityException { http://git-wip-us.apache.org/repos/asf/mina/blob/300782fc/mina-example/src/main/java/org/apache/mina/example/gettingstarted/timeserver/MinaTimeServer.java ---------------------------------------------------------------------- diff --git a/mina-example/src/main/java/org/apache/mina/example/gettingstarted/timeserver/MinaTimeServer.java b/mina-example/src/main/java/org/apache/mina/example/gettingstarted/timeserver/MinaTimeServer.java index 72085ed..88158bb 100644 --- a/mina-example/src/main/java/org/apache/mina/example/gettingstarted/timeserver/MinaTimeServer.java +++ b/mina-example/src/main/java/org/apache/mina/example/gettingstarted/timeserver/MinaTimeServer.java @@ -46,6 +46,9 @@ public class MinaTimeServer { /** * The server implementation. It's based on TCP, and uses a logging filter * plus a text line decoder. + * + * @param args The arguments + * @throws IOException If something went wrong */ public static void main(String[] args) throws IOException { // Create the acceptor http://git-wip-us.apache.org/repos/asf/mina/blob/300782fc/mina-example/src/main/java/org/apache/mina/example/proxy/AbstractProxyIoHandler.java ---------------------------------------------------------------------- diff --git a/mina-example/src/main/java/org/apache/mina/example/proxy/AbstractProxyIoHandler.java b/mina-example/src/main/java/org/apache/mina/example/proxy/AbstractProxyIoHandler.java index 197fde9..1b71c77 100644 --- a/mina-example/src/main/java/org/apache/mina/example/proxy/AbstractProxyIoHandler.java +++ b/mina-example/src/main/java/org/apache/mina/example/proxy/AbstractProxyIoHandler.java @@ -39,12 +39,18 @@ public abstract class AbstractProxyIoHandler extends IoHandlerAdapter { private final static Logger LOGGER = LoggerFactory.getLogger(AbstractProxyIoHandler.class); + /** + * {@inheritDoc} + */ @Override public void sessionCreated(IoSession session) throws Exception { session.suspendRead(); session.suspendWrite(); } + /** + * {@inheritDoc} + */ @Override public void sessionClosed(IoSession session) throws Exception { if (session.getAttribute( OTHER_IO_SESSION ) != null) { @@ -55,6 +61,9 @@ public abstract class AbstractProxyIoHandler extends IoHandlerAdapter { } } + /** + * {@inheritDoc} + */ @Override public void messageReceived(IoSession session, Object message) throws Exception { http://git-wip-us.apache.org/repos/asf/mina/blob/300782fc/mina-example/src/main/java/org/apache/mina/example/sumup/codec/AbstractMessageDecoder.java ---------------------------------------------------------------------- diff --git a/mina-example/src/main/java/org/apache/mina/example/sumup/codec/AbstractMessageDecoder.java b/mina-example/src/main/java/org/apache/mina/example/sumup/codec/AbstractMessageDecoder.java index 225557a..779327a 100644 --- a/mina-example/src/main/java/org/apache/mina/example/sumup/codec/AbstractMessageDecoder.java +++ b/mina-example/src/main/java/org/apache/mina/example/sumup/codec/AbstractMessageDecoder.java @@ -82,6 +82,8 @@ public abstract class AbstractMessageDecoder implements MessageDecoder { } /** + * @param session The current session + * @param in The incoming buffer * @return <tt>null</tt> if the whole body is not read yet */ protected abstract AbstractMessage decodeBody(IoSession session, http://git-wip-us.apache.org/repos/asf/mina/blob/300782fc/mina-example/src/main/java/org/apache/mina/example/tcp/perf/TcpClient.java ---------------------------------------------------------------------- diff --git a/mina-example/src/main/java/org/apache/mina/example/tcp/perf/TcpClient.java b/mina-example/src/main/java/org/apache/mina/example/tcp/perf/TcpClient.java index 12dd3f3..fdab45d 100644 --- a/mina-example/src/main/java/org/apache/mina/example/tcp/perf/TcpClient.java +++ b/mina-example/src/main/java/org/apache/mina/example/tcp/perf/TcpClient.java @@ -114,8 +114,8 @@ public class TcpClient extends IoHandlerAdapter { /** * The main method : instanciates a client, and send N messages. We sleep * between each K messages sent, to avoid the server saturation. - * @param args - * @throws Exception + * @param args The arguments + * @throws Exception If something went wrong */ public static void main(String[] args) throws Exception { TcpClient client = new TcpClient(); http://git-wip-us.apache.org/repos/asf/mina/blob/300782fc/mina-example/src/main/java/org/apache/mina/example/tcp/perf/TcpServer.java ---------------------------------------------------------------------- diff --git a/mina-example/src/main/java/org/apache/mina/example/tcp/perf/TcpServer.java b/mina-example/src/main/java/org/apache/mina/example/tcp/perf/TcpServer.java index ffda31d..702c808 100644 --- a/mina-example/src/main/java/org/apache/mina/example/tcp/perf/TcpServer.java +++ b/mina-example/src/main/java/org/apache/mina/example/tcp/perf/TcpServer.java @@ -113,6 +113,8 @@ public class TcpServer extends IoHandlerAdapter { /** * {@inheritDoc} + * @param session the current seession + * @throws Exception If something went wrong */ @Override public void sessionOpened(IoSession session) throws Exception { @@ -121,6 +123,8 @@ public class TcpServer extends IoHandlerAdapter { /** * Create the TCP server + * + * @throws IOException If something went wrong */ public TcpServer() throws IOException { NioSocketAcceptor acceptor = new NioSocketAcceptor(); @@ -137,6 +141,9 @@ public class TcpServer extends IoHandlerAdapter { /** * The entry point. + * + * @param args The arguments + * @throws IOException If something went wrong */ public static void main(String[] args) throws IOException { new TcpServer(); http://git-wip-us.apache.org/repos/asf/mina/blob/300782fc/mina-example/src/main/java/org/apache/mina/example/tennis/TennisBall.java ---------------------------------------------------------------------- diff --git a/mina-example/src/main/java/org/apache/mina/example/tennis/TennisBall.java b/mina-example/src/main/java/org/apache/mina/example/tennis/TennisBall.java index 7226674..3a16340 100644 --- a/mina-example/src/main/java/org/apache/mina/example/tennis/TennisBall.java +++ b/mina-example/src/main/java/org/apache/mina/example/tennis/TennisBall.java @@ -32,6 +32,8 @@ public class TennisBall { /** * Creates a new ball with the specified TTL (Time To Live) value. + * + * @param ttl The time to live */ public TennisBall(int ttl) { this(ttl, true); @@ -46,14 +48,14 @@ public class TennisBall { } /** - * Returns the TTL value of this ball. + * @return the TTL value of this ball. */ public int getTTL() { return ttl; } /** - * Returns the ball after {@link TennisPlayer}'s stroke. + * @return the ball after {@link TennisPlayer}'s stroke. * The returned ball has decreased TTL value and switched PING/PONG state. */ public TennisBall stroke() { @@ -61,7 +63,7 @@ public class TennisBall { } /** - * Returns string representation of this message (<code>[PING|PONG] + * @return string representation of this message (<code>[PING|PONG] * (TTL)</code>). */ @Override http://git-wip-us.apache.org/repos/asf/mina/blob/300782fc/mina-example/src/main/java/org/apache/mina/example/udp/perf/UdpClient.java ---------------------------------------------------------------------- diff --git a/mina-example/src/main/java/org/apache/mina/example/udp/perf/UdpClient.java b/mina-example/src/main/java/org/apache/mina/example/udp/perf/UdpClient.java index f267133..7bde50e 100644 --- a/mina-example/src/main/java/org/apache/mina/example/udp/perf/UdpClient.java +++ b/mina-example/src/main/java/org/apache/mina/example/udp/perf/UdpClient.java @@ -19,6 +19,7 @@ */ package org.apache.mina.example.udp.perf; +import java.io.IOException; import java.net.InetSocketAddress; import org.apache.mina.core.buffer.IoBuffer; @@ -112,8 +113,8 @@ public class UdpClient extends IoHandlerAdapter { /** * The main method : instanciates a client, and send N messages. We sleep * between each K messages sent, to avoid the server saturation. - * @param args - * @throws Exception + * @param args The arguments + * @throws Exception If something went wrong */ public static void main(String[] args) throws Exception { UdpClient client = new UdpClient(); http://git-wip-us.apache.org/repos/asf/mina/blob/300782fc/mina-example/src/main/java/org/apache/mina/example/udp/perf/UdpServer.java ---------------------------------------------------------------------- diff --git a/mina-example/src/main/java/org/apache/mina/example/udp/perf/UdpServer.java b/mina-example/src/main/java/org/apache/mina/example/udp/perf/UdpServer.java index af969a9..379af26 100644 --- a/mina-example/src/main/java/org/apache/mina/example/udp/perf/UdpServer.java +++ b/mina-example/src/main/java/org/apache/mina/example/udp/perf/UdpServer.java @@ -121,6 +121,8 @@ public class UdpServer extends IoHandlerAdapter { /** * Create the UDP server + * + * @throws IOException If something went wrong */ public UdpServer() throws IOException { NioDatagramAcceptor acceptor = new NioDatagramAcceptor(); @@ -137,6 +139,9 @@ public class UdpServer extends IoHandlerAdapter { /** * The entry point. + * + * @param args The arguments + * @throws IOException If something went wrong */ public static void main(String[] args) throws IOException { new UdpServer(); http://git-wip-us.apache.org/repos/asf/mina/blob/300782fc/mina-filter-compression/src/main/java/org/apache/mina/filter/compression/CompressionFilter.java ---------------------------------------------------------------------- diff --git a/mina-filter-compression/src/main/java/org/apache/mina/filter/compression/CompressionFilter.java b/mina-filter-compression/src/main/java/org/apache/mina/filter/compression/CompressionFilter.java index 5d4be68..b57f090 100644 --- a/mina-filter-compression/src/main/java/org/apache/mina/filter/compression/CompressionFilter.java +++ b/mina-filter-compression/src/main/java/org/apache/mina/filter/compression/CompressionFilter.java @@ -201,7 +201,7 @@ public class CompressionFilter extends WriteRequestFilter { } /** - * Returns <tt>true</tt> if incoming data is being compressed. + * @return <tt>true</tt> if incoming data is being compressed. */ public boolean isCompressInbound() { return compressInbound; @@ -209,13 +209,15 @@ public class CompressionFilter extends WriteRequestFilter { /** * Sets if incoming data has to be compressed. + * + * @param compressInbound <tt>true</tt> if the incoming data has to be compressed */ public void setCompressInbound(boolean compressInbound) { this.compressInbound = compressInbound; } /** - * Returns <tt>true</tt> if the filter is compressing data being written. + * @return <tt>true</tt> if the filter is compressing data being written. */ public boolean isCompressOutbound() { return compressOutbound; @@ -223,6 +225,8 @@ public class CompressionFilter extends WriteRequestFilter { /** * Set if outgoing data has to be compressed. + * + * @param compressOutbound <tt>true</tt> if the outgoing data has to be compressed */ public void setCompressOutbound(boolean compressOutbound) { this.compressOutbound = compressOutbound; http://git-wip-us.apache.org/repos/asf/mina/blob/300782fc/mina-http/src/main/java/org/apache/mina/http/api/HttpMessage.java ---------------------------------------------------------------------- diff --git a/mina-http/src/main/java/org/apache/mina/http/api/HttpMessage.java b/mina-http/src/main/java/org/apache/mina/http/api/HttpMessage.java index 0de11b9..5be423e 100644 --- a/mina-http/src/main/java/org/apache/mina/http/api/HttpMessage.java +++ b/mina-http/src/main/java/org/apache/mina/http/api/HttpMessage.java @@ -44,7 +44,7 @@ public interface HttpMessage { String getContentType(); /** - * Returns <tt>true</tt> if this message enables keep-alive connection. + * @return <tt>true</tt> if this message enables keep-alive connection. */ boolean isKeepAlive(); @@ -58,12 +58,13 @@ public interface HttpMessage { String getHeader(String name); /** - * Returns <tt>true</tt> if the HTTP header with the specified name exists in this request. + * @param name the Header's name we are looking for + * @return <tt>true</tt> if the HTTP header with the specified name exists in this request. */ boolean containsHeader(String name); /** - * Returns a read-only {@link Map} of HTTP headers whose key is a {@link String} and whose value is a {@link String} + * @return a read-only {@link Map} of HTTP headers whose key is a {@link String} and whose value is a {@link String} * s. */ Map<String, String> getHeaders(); http://git-wip-us.apache.org/repos/asf/mina/blob/300782fc/mina-http/src/main/java/org/apache/mina/http/api/HttpRequest.java ---------------------------------------------------------------------- diff --git a/mina-http/src/main/java/org/apache/mina/http/api/HttpRequest.java b/mina-http/src/main/java/org/apache/mina/http/api/HttpRequest.java index a6774dd..f895138 100644 --- a/mina-http/src/main/java/org/apache/mina/http/api/HttpRequest.java +++ b/mina-http/src/main/java/org/apache/mina/http/api/HttpRequest.java @@ -53,7 +53,7 @@ public interface HttpRequest extends HttpMessage { String getQueryString(); /** - * Returns a read only {@link Map} of query parameters whose key is a {@link String} and whose value is a + * @return a read only {@link Map} of query parameters whose key is a {@link String} and whose value is a * {@link List} of {@link String}s. */ Map<String, List<String>> getParameters(); http://git-wip-us.apache.org/repos/asf/mina/blob/300782fc/mina-http/src/main/java/org/apache/mina/http/api/HttpVersion.java ---------------------------------------------------------------------- diff --git a/mina-http/src/main/java/org/apache/mina/http/api/HttpVersion.java b/mina-http/src/main/java/org/apache/mina/http/api/HttpVersion.java index cb74472..95655bf 100644 --- a/mina-http/src/main/java/org/apache/mina/http/api/HttpVersion.java +++ b/mina-http/src/main/java/org/apache/mina/http/api/HttpVersion.java @@ -44,6 +44,7 @@ public enum HttpVersion { /** * Returns the {@link HttpVersion} instance from the specified string. * + * @param string The String contaoning the HTTP version * @return The version, or <code>null</code> if no version is found */ public static HttpVersion fromString(String string) { http://git-wip-us.apache.org/repos/asf/mina/blob/300782fc/mina-integration-jmx/src/main/java/org/apache/mina/integration/jmx/ObjectMBean.java ---------------------------------------------------------------------- diff --git a/mina-integration-jmx/src/main/java/org/apache/mina/integration/jmx/ObjectMBean.java b/mina-integration-jmx/src/main/java/org/apache/mina/integration/jmx/ObjectMBean.java index 3758c48..8d24ba7 100644 --- a/mina-integration-jmx/src/main/java/org/apache/mina/integration/jmx/ObjectMBean.java +++ b/mina-integration-jmx/src/main/java/org/apache/mina/integration/jmx/ObjectMBean.java @@ -134,6 +134,8 @@ public class ObjectMBean<T> implements ModelMBean, MBeanRegistration { /** * Creates a new instance with the specified POJO. + * + * @param source The original POJO */ public ObjectMBean(T source) { if (source == null) { http://git-wip-us.apache.org/repos/asf/mina/blob/300782fc/mina-integration-ognl/src/main/java/org/apache/mina/integration/ognl/IoSessionFinder.java ---------------------------------------------------------------------- diff --git a/mina-integration-ognl/src/main/java/org/apache/mina/integration/ognl/IoSessionFinder.java b/mina-integration-ognl/src/main/java/org/apache/mina/integration/ognl/IoSessionFinder.java index 73e77f5..f361e42 100644 --- a/mina-integration-ognl/src/main/java/org/apache/mina/integration/ognl/IoSessionFinder.java +++ b/mina-integration-ognl/src/main/java/org/apache/mina/integration/ognl/IoSessionFinder.java @@ -42,6 +42,8 @@ public class IoSessionFinder { /** * Creates a new instance with the specified OGNL expression that returns * a boolean value (e.g. <tt>"id == 0x12345678"</tt>). + * + * @param query The OGNL expression */ public IoSessionFinder(String query) { if (query == null) { @@ -49,11 +51,13 @@ public class IoSessionFinder { } query = query.trim(); + if (query.length() == 0) { throw new IllegalArgumentException("query is empty."); } this.query = query; + try { expression = Ognl.parseExpression(query); } catch (OgnlException e) { @@ -65,6 +69,10 @@ public class IoSessionFinder { * Finds a {@link Set} of {@link IoSession}s that matches the query * from the specified sessions and returns the matches. * @throws OgnlException if failed to evaluate the OGNL expression + * + * @param sessions The list of sessions to check + * @return A set of the session that matches the query + * @throws OgnlException If we can't find a boolean value in a session's context */ public Set<IoSession> find(Iterable<IoSession> sessions) throws OgnlException { if (sessions == null) { @@ -72,12 +80,14 @@ public class IoSessionFinder { } Set<IoSession> answer = new LinkedHashSet<IoSession>(); + for (IoSession s : sessions) { OgnlContext context = (OgnlContext) Ognl.createDefaultContext(s); context.setTypeConverter(typeConverter); context.put(AbstractPropertyAccessor.READ_ONLY_MODE, true); context.put(AbstractPropertyAccessor.QUERY, query); Object result = Ognl.getValue(expression, context, s); + if (result instanceof Boolean) { if (((Boolean) result).booleanValue()) { answer.add(s); http://git-wip-us.apache.org/repos/asf/mina/blob/300782fc/mina-integration-xbean/src/main/java/org/apache/mina/integration/xbean/SocketAddressFactory.java ---------------------------------------------------------------------- diff --git a/mina-integration-xbean/src/main/java/org/apache/mina/integration/xbean/SocketAddressFactory.java b/mina-integration-xbean/src/main/java/org/apache/mina/integration/xbean/SocketAddressFactory.java index fe51531..9fe149c 100644 --- a/mina-integration-xbean/src/main/java/org/apache/mina/integration/xbean/SocketAddressFactory.java +++ b/mina-integration-xbean/src/main/java/org/apache/mina/integration/xbean/SocketAddressFactory.java @@ -33,10 +33,15 @@ import org.apache.mina.integration.beans.InetSocketAddressEditor; public class SocketAddressFactory { /** * @org.apache.xbean.FactoryMethod + * Creates a SocketAddress from its String description + * + * @param value The socket address as a String + * @return A SocketAddress */ public static SocketAddress create(String value) { InetSocketAddressEditor editor = new InetSocketAddressEditor(); editor.setAsText(value); + return (SocketAddress) editor.getValue(); } } http://git-wip-us.apache.org/repos/asf/mina/blob/300782fc/mina-statemachine/src/main/java/org/apache/mina/statemachine/State.java ---------------------------------------------------------------------- diff --git a/mina-statemachine/src/main/java/org/apache/mina/statemachine/State.java b/mina-statemachine/src/main/java/org/apache/mina/statemachine/State.java index 77f437e..c598512 100644 --- a/mina-statemachine/src/main/java/org/apache/mina/statemachine/State.java +++ b/mina-statemachine/src/main/java/org/apache/mina/statemachine/State.java @@ -81,17 +81,13 @@ public class State { } /** - * Returns the id of this {@link State}. - * - * @return the id. + * @return the id of this {@link State}. */ public String getId() { return id; } /** - * Returns the parent {@link State}. - * * @return the parent or <code>null</code> if this {@link State} has no * parent. */ @@ -100,28 +96,22 @@ public class State { } /** - * Returns an unmodifiable {@link List} of {@link Transition}s going out + * @return an unmodifiable {@link List} of {@link Transition}s going out * from this {@link State}. - * - * @return the {@link Transition}s. */ public List<Transition> getTransitions() { return Collections.unmodifiableList(transitions); } /** - * Returns an unmodifiable {@link List} of entry {@link SelfTransition}s - * - * @return the {@link SelfTransition}s. + * @return an unmodifiable {@link List} of entry {@link SelfTransition}s */ public List<SelfTransition> getOnEntrySelfTransitions() { return Collections.unmodifiableList(onEntries); } /** - * Returns an unmodifiable {@link List} of exit {@link SelfTransition}s - * - * @return the {@link SelfTransition}s. + * @return an unmodifiable {@link List} of exit {@link SelfTransition}s */ public List<SelfTransition> getOnExitSelfTransitions() { return Collections.unmodifiableList(onExits); @@ -181,6 +171,7 @@ public class State { * be executed. * * @param transition the {@link Transition} to add. + * @param weight The weight of this transition * @return this {@link State}. */ public State addTransition(Transition transition, int weight) { @@ -194,23 +185,35 @@ public class State { return this; } + /** + * {@inheritDoc} + */ @Override public boolean equals(Object o) { - if (!(o instanceof State)) { - return false; - } if (o == this) { return true; } + + if (!(o instanceof State)) { + return false; + } + State that = (State) o; + return new EqualsBuilder().append(this.id, that.id).isEquals(); } + /** + * {@inheritDoc} + */ @Override public int hashCode() { return new HashCodeBuilder(13, 33).append(this.id).toHashCode(); } + /** + * {@inheritDoc} + */ @Override public String toString() { return new ToStringBuilder(this).append("id", this.id).toString(); http://git-wip-us.apache.org/repos/asf/mina/blob/300782fc/mina-statemachine/src/main/java/org/apache/mina/statemachine/StateMachine.java ---------------------------------------------------------------------- diff --git a/mina-statemachine/src/main/java/org/apache/mina/statemachine/StateMachine.java b/mina-statemachine/src/main/java/org/apache/mina/statemachine/StateMachine.java index 8f4f5e3..dfc031c 100644 --- a/mina-statemachine/src/main/java/org/apache/mina/statemachine/StateMachine.java +++ b/mina-statemachine/src/main/java/org/apache/mina/statemachine/StateMachine.java @@ -108,10 +108,8 @@ public class StateMachine { } /** - * Returns an unmodifiable {@link Collection} of all {@link State}s used by + * @return an unmodifiable {@link Collection} of all {@link State}s used by * this {@link StateMachine}. - * - * @return the {@link State}s. */ public Collection<State> getStates() { return Collections.unmodifiableCollection(states.values()); http://git-wip-us.apache.org/repos/asf/mina/blob/300782fc/mina-statemachine/src/main/java/org/apache/mina/statemachine/StateMachineProxyBuilder.java ---------------------------------------------------------------------- diff --git a/mina-statemachine/src/main/java/org/apache/mina/statemachine/StateMachineProxyBuilder.java b/mina-statemachine/src/main/java/org/apache/mina/statemachine/StateMachineProxyBuilder.java index dcc9eb6..d9488e1 100644 --- a/mina-statemachine/src/main/java/org/apache/mina/statemachine/StateMachineProxyBuilder.java +++ b/mina-statemachine/src/main/java/org/apache/mina/statemachine/StateMachineProxyBuilder.java @@ -158,6 +158,7 @@ public class StateMachineProxyBuilder { * Creates a proxy for the specified interface and which uses the specified * {@link StateMachine}. * + * @param <T> The specified interface type * @param iface the interface the proxy will implement. * @param sm the {@link StateMachine} which will receive the events * generated by the method calls on the proxy. http://git-wip-us.apache.org/repos/asf/mina/blob/300782fc/mina-statemachine/src/main/java/org/apache/mina/statemachine/annotation/IoFilterTransition.java ---------------------------------------------------------------------- diff --git a/mina-statemachine/src/main/java/org/apache/mina/statemachine/annotation/IoFilterTransition.java b/mina-statemachine/src/main/java/org/apache/mina/statemachine/annotation/IoFilterTransition.java index de3a186..a9eb85d 100644 --- a/mina-statemachine/src/main/java/org/apache/mina/statemachine/annotation/IoFilterTransition.java +++ b/mina-statemachine/src/main/java/org/apache/mina/statemachine/annotation/IoFilterTransition.java @@ -41,26 +41,26 @@ import org.apache.mina.statemachine.event.IoFilterEvents; @TransitionAnnotation(IoFilterTransitions.class) public @interface IoFilterTransition { /** - * Specifies the ids of one or more events handled by the annotated method. If + * @return Specifies the ids of one or more events handled by the annotated method. If * not specified the handler method will be executed for any event. */ IoFilterEvents[] on() default IoFilterEvents.ANY; /** - * The id of the state or states that this handler applies to. Must be + * @return The id of the state or states that this handler applies to. Must be * specified. */ String[] in(); /** - * The id of the state the {@link StateMachine} should move to next after + * @return The id of the state the {@link StateMachine} should move to next after * executing the annotated method. If not specified the {@link StateMachine} * will remain in the same state. */ String next() default Transition.SELF; /** - * The weight used to order handler annotations which match the same event + * @return The weight used to order handler annotations which match the same event * in the same state. Transitions with lower weight will be matched first. The * default weight is 0. */ http://git-wip-us.apache.org/repos/asf/mina/blob/300782fc/mina-statemachine/src/main/java/org/apache/mina/statemachine/annotation/IoHandlerTransition.java ---------------------------------------------------------------------- diff --git a/mina-statemachine/src/main/java/org/apache/mina/statemachine/annotation/IoHandlerTransition.java b/mina-statemachine/src/main/java/org/apache/mina/statemachine/annotation/IoHandlerTransition.java index f2d223a..e502bf0 100644 --- a/mina-statemachine/src/main/java/org/apache/mina/statemachine/annotation/IoHandlerTransition.java +++ b/mina-statemachine/src/main/java/org/apache/mina/statemachine/annotation/IoHandlerTransition.java @@ -41,26 +41,26 @@ import org.apache.mina.statemachine.event.IoHandlerEvents; @TransitionAnnotation(IoHandlerTransitions.class) public @interface IoHandlerTransition { /** - * Specifies the ids of one or more events handled by the annotated method. If + * @return Specifies the ids of one or more events handled by the annotated method. If * not specified the handler method will be executed for any event. */ IoHandlerEvents[] on() default IoHandlerEvents.ANY; /** - * The id of the state or states that this handler applies to. Must be + * @return The id of the state or states that this handler applies to. Must be * specified. */ String[] in(); /** - * The id of the state the {@link StateMachine} should move to next after + * @return The id of the state the {@link StateMachine} should move to next after * executing the annotated method. If not specified the {@link StateMachine} * will remain in the same state. */ String next() default Transition.SELF; /** - * The weight used to order handler annotations which match the same event + * @return The weight used to order handler annotations which match the same event * in the same state. Transitions with lower weight will be matched first. The * default weight is 0. */ http://git-wip-us.apache.org/repos/asf/mina/blob/300782fc/mina-statemachine/src/main/java/org/apache/mina/statemachine/annotation/OnEntry.java ---------------------------------------------------------------------- diff --git a/mina-statemachine/src/main/java/org/apache/mina/statemachine/annotation/OnEntry.java b/mina-statemachine/src/main/java/org/apache/mina/statemachine/annotation/OnEntry.java index d3a0c40..62ad3ac 100644 --- a/mina-statemachine/src/main/java/org/apache/mina/statemachine/annotation/OnEntry.java +++ b/mina-statemachine/src/main/java/org/apache/mina/statemachine/annotation/OnEntry.java @@ -35,6 +35,8 @@ import java.lang.annotation.Target; public @interface OnEntry { /** * Sets the id of related state. + * + * @return The id of the related state */ String value(); } http://git-wip-us.apache.org/repos/asf/mina/blob/300782fc/mina-statemachine/src/main/java/org/apache/mina/statemachine/annotation/OnExit.java ---------------------------------------------------------------------- diff --git a/mina-statemachine/src/main/java/org/apache/mina/statemachine/annotation/OnExit.java b/mina-statemachine/src/main/java/org/apache/mina/statemachine/annotation/OnExit.java index 16c499a..06edbff 100644 --- a/mina-statemachine/src/main/java/org/apache/mina/statemachine/annotation/OnExit.java +++ b/mina-statemachine/src/main/java/org/apache/mina/statemachine/annotation/OnExit.java @@ -35,6 +35,8 @@ import java.lang.annotation.Target; public @interface OnExit { /** * Sets the id of related state. + * + * @return the id of the related state */ String value(); } http://git-wip-us.apache.org/repos/asf/mina/blob/300782fc/mina-statemachine/src/main/java/org/apache/mina/statemachine/annotation/State.java ---------------------------------------------------------------------- diff --git a/mina-statemachine/src/main/java/org/apache/mina/statemachine/annotation/State.java b/mina-statemachine/src/main/java/org/apache/mina/statemachine/annotation/State.java index 7c28dc7..27b9eea 100644 --- a/mina-statemachine/src/main/java/org/apache/mina/statemachine/annotation/State.java +++ b/mina-statemachine/src/main/java/org/apache/mina/statemachine/annotation/State.java @@ -38,6 +38,8 @@ public @interface State { /** * Sets the id of the parent state. The default is no parent. + * + * @return the id of the parent state */ String value() default ROOT; } http://git-wip-us.apache.org/repos/asf/mina/blob/300782fc/mina-statemachine/src/main/java/org/apache/mina/statemachine/annotation/Transition.java ---------------------------------------------------------------------- diff --git a/mina-statemachine/src/main/java/org/apache/mina/statemachine/annotation/Transition.java b/mina-statemachine/src/main/java/org/apache/mina/statemachine/annotation/Transition.java index 5256ac0..e7c9925 100644 --- a/mina-statemachine/src/main/java/org/apache/mina/statemachine/annotation/Transition.java +++ b/mina-statemachine/src/main/java/org/apache/mina/statemachine/annotation/Transition.java @@ -42,12 +42,16 @@ public @interface Transition { /** * Specifies the ids of one or more events handled by the annotated method. If * not specified the handler method will be executed for any event. + * + * @return the ids of the handled events */ String[] on() default Event.WILDCARD_EVENT_ID; /** * The id of the state or states that this handler applies to. Must be * specified. + * + * @return the ids of the handled states */ String[] in(); @@ -55,6 +59,8 @@ public @interface Transition { * The id of the state the {@link StateMachine} should move to next after * executing the annotated method. If not specified the {@link StateMachine} * will remain in the same state. + * + * @return the id of the next state */ String next() default SELF; @@ -62,6 +68,8 @@ public @interface Transition { * The weight used to order handler annotations which match the same event * in the same state. Transitions with lower weight will be matched first. The * default weight is 0. + * + * @return the weight used to order the handler */ int weight() default 0; } http://git-wip-us.apache.org/repos/asf/mina/blob/300782fc/mina-statemachine/src/main/java/org/apache/mina/statemachine/context/StateContext.java ---------------------------------------------------------------------- diff --git a/mina-statemachine/src/main/java/org/apache/mina/statemachine/context/StateContext.java b/mina-statemachine/src/main/java/org/apache/mina/statemachine/context/StateContext.java index 6b65de4..49fa0dd 100644 --- a/mina-statemachine/src/main/java/org/apache/mina/statemachine/context/StateContext.java +++ b/mina-statemachine/src/main/java/org/apache/mina/statemachine/context/StateContext.java @@ -33,9 +33,7 @@ import org.apache.mina.statemachine.StateMachine; */ public interface StateContext { /** - * Returns the current {@link State}. This is only meant for internal use. - * - * @return the current {@link State}. + * @return the current {@link State}. This is only meant for internal use. */ State getCurrentState(); http://git-wip-us.apache.org/repos/asf/mina/blob/300782fc/mina-statemachine/src/main/java/org/apache/mina/statemachine/context/StateContextLookup.java ---------------------------------------------------------------------- diff --git a/mina-statemachine/src/main/java/org/apache/mina/statemachine/context/StateContextLookup.java b/mina-statemachine/src/main/java/org/apache/mina/statemachine/context/StateContextLookup.java index 89d63cb..345c36c 100644 --- a/mina-statemachine/src/main/java/org/apache/mina/statemachine/context/StateContextLookup.java +++ b/mina-statemachine/src/main/java/org/apache/mina/statemachine/context/StateContextLookup.java @@ -33,6 +33,9 @@ public interface StateContextLookup { * must create a new {@link StateContext} if a compatible object is in * the arguments and the next time that same object is passed to this * method the same {@link StateContext} should be returned. + * + * @param eventArgs The arguments we are looking for + * @return The StateContext we are looking for */ StateContext lookup(Object[] eventArgs); } http://git-wip-us.apache.org/repos/asf/mina/blob/300782fc/mina-statemachine/src/main/java/org/apache/mina/statemachine/event/Event.java ---------------------------------------------------------------------- diff --git a/mina-statemachine/src/main/java/org/apache/mina/statemachine/event/Event.java b/mina-statemachine/src/main/java/org/apache/mina/statemachine/event/Event.java index 4d6b6c9..f81b47a 100644 --- a/mina-statemachine/src/main/java/org/apache/mina/statemachine/event/Event.java +++ b/mina-statemachine/src/main/java/org/apache/mina/statemachine/event/Event.java @@ -71,27 +71,21 @@ public class Event { } /** - * Returns the {@link StateContext} this {@link Event} was triggered for. - * - * @return the {@link StateContext}. + * @return the {@link StateContext} this {@link Event} was triggered for. */ public StateContext getContext() { return context; } /** - * Returns the id of this {@link Event}. - * - * @return the id. + * @return the id of this {@link Event}. */ public Object getId() { return id; } /** - * Returns the arguments of this {@link Event}. - * - * @return the arguments. Returns an empty array if this {@link Event} has + * @return the arguments of this {@link Event}. @return an empty array if this {@link Event} has * no arguments. */ public Object[] getArguments() { http://git-wip-us.apache.org/repos/asf/mina/blob/300782fc/mina-statemachine/src/main/java/org/apache/mina/statemachine/event/UnhandledEventException.java ---------------------------------------------------------------------- diff --git a/mina-statemachine/src/main/java/org/apache/mina/statemachine/event/UnhandledEventException.java b/mina-statemachine/src/main/java/org/apache/mina/statemachine/event/UnhandledEventException.java index 2676f48..c4039fd 100644 --- a/mina-statemachine/src/main/java/org/apache/mina/statemachine/event/UnhandledEventException.java +++ b/mina-statemachine/src/main/java/org/apache/mina/statemachine/event/UnhandledEventException.java @@ -35,9 +35,7 @@ public class UnhandledEventException extends RuntimeException { } /** - * Returns the {@link Event} which couldn't be handled. - * - * @return the {@link Event}. + * @return the {@link Event} which couldn't be handled. */ public Event getEvent() { return event; http://git-wip-us.apache.org/repos/asf/mina/blob/300782fc/mina-statemachine/src/main/java/org/apache/mina/statemachine/transition/AbstractSelfTransition.java ---------------------------------------------------------------------- diff --git a/mina-statemachine/src/main/java/org/apache/mina/statemachine/transition/AbstractSelfTransition.java b/mina-statemachine/src/main/java/org/apache/mina/statemachine/transition/AbstractSelfTransition.java index 183d876..a284413 100644 --- a/mina-statemachine/src/main/java/org/apache/mina/statemachine/transition/AbstractSelfTransition.java +++ b/mina-statemachine/src/main/java/org/apache/mina/statemachine/transition/AbstractSelfTransition.java @@ -29,10 +29,8 @@ import org.apache.mina.statemachine.State; */ public abstract class AbstractSelfTransition implements SelfTransition { - /** * Creates a new instance - * */ public AbstractSelfTransition() { @@ -41,14 +39,18 @@ public abstract class AbstractSelfTransition implements SelfTransition { /** * Executes this {@link SelfTransition}. * + * @param stateContext the context in which the execution should occur + * @param state the current state * @return <tt>true</tt> if the {@link SelfTransition} has been executed * successfully */ protected abstract boolean doExecute(StateContext stateContext, State state); + /** + * {@inheritDoc} + */ public boolean execute(StateContext stateContext, State state) { return doExecute(stateContext, state); } - } http://git-wip-us.apache.org/repos/asf/mina/blob/300782fc/mina-statemachine/src/main/java/org/apache/mina/statemachine/transition/MethodSelfTransition.java ---------------------------------------------------------------------- diff --git a/mina-statemachine/src/main/java/org/apache/mina/statemachine/transition/MethodSelfTransition.java b/mina-statemachine/src/main/java/org/apache/mina/statemachine/transition/MethodSelfTransition.java index 3d1c464..26156da 100644 --- a/mina-statemachine/src/main/java/org/apache/mina/statemachine/transition/MethodSelfTransition.java +++ b/mina-statemachine/src/main/java/org/apache/mina/statemachine/transition/MethodSelfTransition.java @@ -90,9 +90,7 @@ public class MethodSelfTransition extends AbstractSelfTransition { } /** - * Returns the target {@link Method}. - * - * @return the method. + * @return the target {@link Method}. */ public Method getMethod() { return method; http://git-wip-us.apache.org/repos/asf/mina/blob/300782fc/mina-statemachine/src/main/java/org/apache/mina/statemachine/transition/MethodTransition.java ---------------------------------------------------------------------- diff --git a/mina-statemachine/src/main/java/org/apache/mina/statemachine/transition/MethodTransition.java b/mina-statemachine/src/main/java/org/apache/mina/statemachine/transition/MethodTransition.java index af70cc6..eae72cb 100644 --- a/mina-statemachine/src/main/java/org/apache/mina/statemachine/transition/MethodTransition.java +++ b/mina-statemachine/src/main/java/org/apache/mina/statemachine/transition/MethodTransition.java @@ -179,17 +179,13 @@ public class MethodTransition extends AbstractTransition { } /** - * Returns the target {@link Method}. - * - * @return the method. + * @return the target {@link Method}. */ public Method getMethod() { return method; } /** - * Returns the target object. - * * @return the target object. */ public Object getTarget() { http://git-wip-us.apache.org/repos/asf/mina/blob/300782fc/mina-statemachine/src/main/java/org/apache/mina/statemachine/transition/SelfTransition.java ---------------------------------------------------------------------- diff --git a/mina-statemachine/src/main/java/org/apache/mina/statemachine/transition/SelfTransition.java b/mina-statemachine/src/main/java/org/apache/mina/statemachine/transition/SelfTransition.java index 81a5ce1..7df1dd4 100644 --- a/mina-statemachine/src/main/java/org/apache/mina/statemachine/transition/SelfTransition.java +++ b/mina-statemachine/src/main/java/org/apache/mina/statemachine/transition/SelfTransition.java @@ -32,10 +32,9 @@ public interface SelfTransition { /** * Executes this {@link SelfTransition}. * - * @return <tt>true</tt> if the {@link SelfTransition} was executed, - * <tt>false</tt> otherwise. + * @param stateContext The context in which we are executing the transition + * @param state The current state + * @return <tt>true</tt> if the execution succeeded, <tt>false</tt> otherwise. */ - boolean execute(StateContext stateContext, State state); - } http://git-wip-us.apache.org/repos/asf/mina/blob/300782fc/mina-statemachine/src/main/java/org/apache/mina/statemachine/transition/Transition.java ---------------------------------------------------------------------- diff --git a/mina-statemachine/src/main/java/org/apache/mina/statemachine/transition/Transition.java b/mina-statemachine/src/main/java/org/apache/mina/statemachine/transition/Transition.java index c0efaf7..7166602 100644 --- a/mina-statemachine/src/main/java/org/apache/mina/statemachine/transition/Transition.java +++ b/mina-statemachine/src/main/java/org/apache/mina/statemachine/transition/Transition.java @@ -43,12 +43,10 @@ public interface Transition { boolean execute(Event event); /** - * Returns the {@link State} which the {@link StateMachine} should move to + * @return the {@link State} which the {@link StateMachine} should move to * if this {@link Transition} is taken and {@link #execute(Event)} returns - * <tt>true</tt>. - * - * @return the next {@link State} or <code>null</code> if this - * {@link Transition} is a loopback {@link Transition}. + * <tt>true</tt>. <code>null</code> if this {@link Transition} is a loopback + * {@link Transition}. */ State getNextState(); } http://git-wip-us.apache.org/repos/asf/mina/blob/300782fc/mina-transport-apr/src/main/java/org/apache/mina/transport/socket/apr/AprSocketAcceptor.java ---------------------------------------------------------------------- diff --git a/mina-transport-apr/src/main/java/org/apache/mina/transport/socket/apr/AprSocketAcceptor.java b/mina-transport-apr/src/main/java/org/apache/mina/transport/socket/apr/AprSocketAcceptor.java index 2ecf4ed..eb3d8d1 100644 --- a/mina-transport-apr/src/main/java/org/apache/mina/transport/socket/apr/AprSocketAcceptor.java +++ b/mina-transport-apr/src/main/java/org/apache/mina/transport/socket/apr/AprSocketAcceptor.java @@ -345,6 +345,8 @@ public final class AprSocketAcceptor extends AbstractPollingIoAcceptor<AprSessio /** * @see #setDefaultLocalAddress(SocketAddress) + * + * @param localAddress The localAddress to set */ public void setDefaultLocalAddress(InetSocketAddress localAddress) { super.setDefaultLocalAddress(localAddress); http://git-wip-us.apache.org/repos/asf/mina/blob/300782fc/mina-transport-serial/src/main/java/org/apache/mina/transport/serial/SerialSession.java ---------------------------------------------------------------------- diff --git a/mina-transport-serial/src/main/java/org/apache/mina/transport/serial/SerialSession.java b/mina-transport-serial/src/main/java/org/apache/mina/transport/serial/SerialSession.java index 6ab48ab..c4096d1 100644 --- a/mina-transport-serial/src/main/java/org/apache/mina/transport/serial/SerialSession.java +++ b/mina-transport-serial/src/main/java/org/apache/mina/transport/serial/SerialSession.java @@ -42,18 +42,19 @@ public interface SerialSession extends IoSession { void setRTS(boolean rts); /** - * Gets the state of the RTS (Request To Send) bit in the UART, if supported by the underlying implementation. + * @return the state of the RTS (Request To Send) bit in the UART, if supported by the underlying implementation. */ boolean isRTS(); /** * Sets or clears the DTR (Data Terminal Ready) bit in the UART, if supported by the underlying implementation. + * * @param dtr true for set DTR, false for clearing */ void setDTR(boolean dtr); /** - * Gets the state of the DTR (Data Terminal Ready) bit in the UART, if supported by the underlying implementation. + * @return the state of the DTR (Data Terminal Ready) bit in the UART, if supported by the underlying implementation. */ boolean isDTR(); } http://git-wip-us.apache.org/repos/asf/mina/blob/300782fc/mina-transport-serial/src/main/java/org/apache/mina/transport/serial/SerialSessionConfig.java ---------------------------------------------------------------------- diff --git a/mina-transport-serial/src/main/java/org/apache/mina/transport/serial/SerialSessionConfig.java b/mina-transport-serial/src/main/java/org/apache/mina/transport/serial/SerialSessionConfig.java index 7718429..f8202e3 100644 --- a/mina-transport-serial/src/main/java/org/apache/mina/transport/serial/SerialSessionConfig.java +++ b/mina-transport-serial/src/main/java/org/apache/mina/transport/serial/SerialSessionConfig.java @@ -64,21 +64,21 @@ public interface SerialSessionConfig extends IoSessionConfig { boolean isLowLatency(); /** - * Set the low latency mode, be carefull it's not supported by all the OS/hardware. - * @param lowLatency + * Set the low latency mode, be careful it's not supported by all the OS/hardware. + * @param lowLatency The low latency mode */ void setLowLatency(boolean lowLatency); /** * The current receive threshold (-1 if not enabled). Give the value of the current buffer * needed for generate a new frame. - * @return the receive thresold in bytes or -1 if disabled + * @return the receive threshold in bytes or -1 if disabled */ int getReceiveThreshold(); /** * Set the receive threshold in byte (set it to -1 for disable). The serial port will try to - * provide frame of the given minimal byte count. Be carefull some devices doesn't support it. + * provide frame of the given minimal byte count. Be careful some devices doesn't support it. * @param bytes minimal amount of byte before producing a new frame, or -1 if disabled */ void setReceiveThreshold(int bytes);
