Repository: mina Updated Branches: refs/heads/2.0 26c894d99 -> dfbf50712
Fixed some javadoc Project: http://git-wip-us.apache.org/repos/asf/mina/repo Commit: http://git-wip-us.apache.org/repos/asf/mina/commit/dfbf5071 Tree: http://git-wip-us.apache.org/repos/asf/mina/tree/dfbf5071 Diff: http://git-wip-us.apache.org/repos/asf/mina/diff/dfbf5071 Branch: refs/heads/2.0 Commit: dfbf507129e99ca955e8d9a56c73727bec9cae3a Parents: 26c894d Author: Emmanuel Lécharny <[email protected]> Authored: Thu Jan 21 11:05:14 2016 +0100 Committer: Emmanuel Lécharny <[email protected]> Committed: Thu Jan 21 11:05:14 2016 +0100 ---------------------------------------------------------------------- .../mina/core/future/DefaultIoFuture.java | 2 +- .../polling/AbstractPollingIoProcessor.java | 114 +++++++------------ .../apache/mina/core/service/IoProcessor.java | 8 +- .../mina/core/service/TransportMetadata.java | 12 +- .../org/apache/mina/core/session/IoSession.java | 20 ++-- .../mina/core/write/WriteRequestQueue.java | 2 +- ...ConsumeToDynamicTerminatorDecodingState.java | 4 +- .../ConsumeToLinearWhitespaceDecodingState.java | 2 +- .../codec/statemachine/CrLfDecodingState.java | 6 +- .../codec/statemachine/SkippingState.java | 2 +- .../mina/filter/ssl/SslContextFactory.java | 12 +- .../org/apache/mina/filter/ssl/SslFilter.java | 2 +- .../mina/proxy/AbstractProxyLogicHandler.java | 2 +- .../apache/mina/proxy/ProxyLogicHandler.java | 2 +- .../mina/proxy/utils/StringUtilities.java | 2 +- .../socket/nio/NioDatagramSessionConfig.java | 4 +- .../transport/socket/nio/NioSocketAcceptor.java | 2 +- .../org/apache/mina/http/api/HttpRequest.java | 2 +- .../statemachine/StateMachineProxyBuilder.java | 4 +- .../context/AbstractStateContextLookup.java | 10 +- .../transition/AbstractSelfTransition.java | 2 +- .../transition/AbstractTransition.java | 4 +- .../statemachine/transition/SelfTransition.java | 4 +- .../statemachine/transition/Transition.java | 8 +- 24 files changed, 105 insertions(+), 127 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/mina/blob/dfbf5071/mina-core/src/main/java/org/apache/mina/core/future/DefaultIoFuture.java ---------------------------------------------------------------------- diff --git a/mina-core/src/main/java/org/apache/mina/core/future/DefaultIoFuture.java b/mina-core/src/main/java/org/apache/mina/core/future/DefaultIoFuture.java index 2a4ef4a..acd267e 100644 --- a/mina-core/src/main/java/org/apache/mina/core/future/DefaultIoFuture.java +++ b/mina-core/src/main/java/org/apache/mina/core/future/DefaultIoFuture.java @@ -177,7 +177,7 @@ public class DefaultIoFuture implements IoFuture { * * @param timeoutMillis The delay we will wait for the Future to be ready * @param interruptable Tells if the wait can be interrupted or not - * @return <code>true</code> if the Future is ready + * @return <tt>true</tt> if the Future is ready * @throws InterruptedException If the thread has been interrupted * when it's not allowed. */ http://git-wip-us.apache.org/repos/asf/mina/blob/dfbf5071/mina-core/src/main/java/org/apache/mina/core/polling/AbstractPollingIoProcessor.java ---------------------------------------------------------------------- diff --git a/mina-core/src/main/java/org/apache/mina/core/polling/AbstractPollingIoProcessor.java b/mina-core/src/main/java/org/apache/mina/core/polling/AbstractPollingIoProcessor.java index 3adf325..e524ec2 100644 --- a/mina-core/src/main/java/org/apache/mina/core/polling/AbstractPollingIoProcessor.java +++ b/mina-core/src/main/java/org/apache/mina/core/polling/AbstractPollingIoProcessor.java @@ -220,7 +220,7 @@ public abstract class AbstractPollingIoProcessor<S extends AbstractIoSession> im * Say if the list of {@link IoSession} polled by this {@link IoProcessor} * is empty * - * @return true if at least a session is managed by this {@link IoProcessor} + * @return <tt>true</tt> if at least a session is managed by this {@link IoProcessor} */ protected abstract boolean isSelectorEmpty(); @@ -246,87 +246,76 @@ public abstract class AbstractPollingIoProcessor<S extends AbstractIoSession> im protected abstract Iterator<S> selectedSessions(); /** - * Get the state of a session (preparing, open, closed) + * Get the state of a session (One of OPENING, OPEN, CLOSING) * - * @param session - * the {@link IoSession} to inspect + * @param session the {@link IoSession} to inspect * @return the state of the session */ protected abstract SessionState getState(S session); /** - * Is the session ready for writing + * Tells if the session ready for writing * - * @param session - * the session queried - * @return true is ready, false if not ready + * @param session the queried session + * @return <tt>true</tt> is ready, <tt>false</tt> if not ready */ protected abstract boolean isWritable(S session); /** - * Is the session ready for reading + * Tells if the session ready for reading * - * @param session - * the session queried - * @return true is ready, false if not ready + * @param session the queried session + * @return <tt>true</tt> is ready, <tt>false</tt> if not ready */ protected abstract boolean isReadable(S session); /** - * register a session for writing + * Set the session to be informed when a write event should be processed * - * @param session - * the session registered - * @param isInterested - * true for registering, false for removing + * @param session the session for which we want to be interested in write events + * @param isInterested <tt>true</tt> for registering, <tt>false</tt> for removing + * @throws Exception If there was a problem while registering the session */ protected abstract void setInterestedInWrite(S session, boolean isInterested) throws Exception; /** - * register a session for reading + * Set the session to be informed when a read event should be processed * - * @param session - * the session registered - * @param isInterested - * true for registering, false for removing + * @param session the session for which we want to be interested in read events + * @param isInterested <tt>true</tt> for registering, <tt>false</tt> for removing + * @throws Exception If there was a problem while registering the session */ protected abstract void setInterestedInRead(S session, boolean isInterested) throws Exception; /** - * is this session registered for reading + * Tells if this session is registered for reading * - * @param session - * the session queried - * @return true is registered for reading + * @param session the queried session + * @return <tt>true</tt> is registered for reading */ protected abstract boolean isInterestedInRead(S session); /** - * is this session registered for writing + * Tells if this session is registered for writing * - * @param session - * the session queried - * @return true is registered for writing + * @param session the queried session + * @return <tt>true</tt> is registered for writing */ protected abstract boolean isInterestedInWrite(S session); /** * Initialize the polling of a session. Add it to the polling process. * - * @param session - * the {@link IoSession} to add to the polling - * @throws Exception - * any exception thrown by the underlying system calls + * @param session the {@link IoSession} to add to the polling + * @throws Exception any exception thrown by the underlying system calls */ protected abstract void init(S session) throws Exception; /** * Destroy the underlying client socket handle * - * @param session - * the {@link IoSession} - * @throws Exception - * any exception thrown by the underlying system calls + * @param session the {@link IoSession} + * @throws Exception any exception thrown by the underlying system calls */ protected abstract void destroy(S session) throws Exception; @@ -334,13 +323,10 @@ public abstract class AbstractPollingIoProcessor<S extends AbstractIoSession> im * Reads a sequence of bytes from a {@link IoSession} into the given * {@link IoBuffer}. Is called when the session was found ready for reading. * - * @param session - * the session to read - * @param buf - * the buffer to fill + * @param session the session to read + * @param buf the buffer to fill * @return the number of bytes read - * @throws Exception - * any exception thrown by the underlying system calls + * @throws Exception any exception thrown by the underlying system calls */ protected abstract int read(S session, IoBuffer buf) throws Exception; @@ -348,16 +334,12 @@ public abstract class AbstractPollingIoProcessor<S extends AbstractIoSession> im * Write a sequence of bytes to a {@link IoSession}, means to be called when * a session was found ready for writing. * - * @param session - * the session to write - * @param buf - * the buffer to write - * @param length - * the number of bytes to write can be superior to the number of + * @param session the session to write + * @param buf the buffer to write + * @param length the number of bytes to write can be superior to the number of * bytes remaining in the buffer * @return the number of byte written - * @throws Exception - * any exception thrown by the underlying system calls + * @throws Exception any exception thrown by the underlying system calls */ protected abstract int write(S session, IoBuffer buf, int length) throws Exception; @@ -367,15 +349,11 @@ public abstract class AbstractPollingIoProcessor<S extends AbstractIoSession> im * {@link UnsupportedOperationException} so the file will be send using * usual {@link #write(AbstractIoSession, IoBuffer, int)} call. * - * @param session - * the session to write - * @param region - * the file region to write - * @param length - * the length of the portion to send + * @param session the session to write + * @param region the file region to write + * @param length the length of the portion to send * @return the number of written bytes - * @throws Exception - * any exception thrown by the underlying system calls + * @throws Exception any exception thrown by the underlying system calls */ protected abstract int transferFile(S session, FileRegion region, int length) throws Exception; @@ -440,8 +418,7 @@ public abstract class AbstractPollingIoProcessor<S extends AbstractIoSession> im /** * Updates the traffic mask for a given session * - * @param session - * the session to update + * @param session the session to update */ public final void updateTrafficMask(S session) { trafficControllingSessions.add(session); @@ -473,8 +450,7 @@ public abstract class AbstractPollingIoProcessor<S extends AbstractIoSession> im * trash the buggy selector and create a new one, registring all the sockets * on it. * - * @throws IOException - * If we got an exception + * @throws IOException If we got an exception */ abstract protected void registerNewSelector() throws IOException; @@ -483,9 +459,8 @@ public abstract class AbstractPollingIoProcessor<S extends AbstractIoSession> im * broken connection. In this case, this is a standard case, and we just * have to loop. * - * @return true if a connection has been brutally closed. - * @throws IOException - * If we got an exception + * @return <tt>true</tt> if a connection has been brutally closed. + * @throws IOException If we got an exception */ abstract protected boolean isBrokenConnection() throws IOException; @@ -512,9 +487,8 @@ public abstract class AbstractPollingIoProcessor<S extends AbstractIoSession> im * Process a new session : - initialize it - create its chain - fire the * CREATED listeners if any * - * @param session - * The session to create - * @return true if the session has been registered + * @param session The session to create + * @return <tt>true</tt> if the session has been registered */ private boolean addNow(S session) { boolean registered = false; http://git-wip-us.apache.org/repos/asf/mina/blob/dfbf5071/mina-core/src/main/java/org/apache/mina/core/service/IoProcessor.java ---------------------------------------------------------------------- diff --git a/mina-core/src/main/java/org/apache/mina/core/service/IoProcessor.java b/mina-core/src/main/java/org/apache/mina/core/service/IoProcessor.java index 9b5c07fe..fd63a67 100644 --- a/mina-core/src/main/java/org/apache/mina/core/service/IoProcessor.java +++ b/mina-core/src/main/java/org/apache/mina/core/service/IoProcessor.java @@ -35,14 +35,14 @@ import org.apache.mina.core.write.WriteRequest; public interface IoProcessor<S extends IoSession> { /** - * Returns <tt>true</tt> if and if only {@link #dispose()} method has + * @return <tt>true</tt> if and if only {@link #dispose()} method has * been called. Please note that this method will return <tt>true</tt> * even after all the related resources are released. */ boolean isDisposing(); /** - * Returns <tt>true</tt> if and if only all resources of this processor + * @return <tt>true</tt> if and if only all resources of this processor * have been disposed. */ boolean isDisposed(); @@ -84,6 +84,8 @@ public interface IoProcessor<S extends IoSession> { * Controls the traffic of the specified {@code session} depending of the * {@link IoSession#isReadSuspended()} and {@link IoSession#isWriteSuspended()} * flags + * + * @param session The session to be updated */ void updateTrafficControl(S session); @@ -92,6 +94,8 @@ public interface IoProcessor<S extends IoSession> { * processor so that the I/O processor closes the connection * associated with the {@code session} and releases any other related * resources. + * + * @param session The session to be removed */ void remove(S session); } http://git-wip-us.apache.org/repos/asf/mina/blob/dfbf5071/mina-core/src/main/java/org/apache/mina/core/service/TransportMetadata.java ---------------------------------------------------------------------- diff --git a/mina-core/src/main/java/org/apache/mina/core/service/TransportMetadata.java b/mina-core/src/main/java/org/apache/mina/core/service/TransportMetadata.java index 94b47ec..b7c7111 100644 --- a/mina-core/src/main/java/org/apache/mina/core/service/TransportMetadata.java +++ b/mina-core/src/main/java/org/apache/mina/core/service/TransportMetadata.java @@ -33,7 +33,7 @@ import org.apache.mina.core.session.IoSessionConfig; public interface TransportMetadata { /** - * Returns the name of the service provider (e.g. "nio", "apr" and "rxtx"). + * @return the name of the service provider (e.g. "nio", "apr" and "rxtx"). */ String getProviderName(); @@ -43,31 +43,31 @@ public interface TransportMetadata { String getName(); /** - * Returns <code>true</code> if the session of this transport type is + * @return <tt>true</tt> if the session of this transport type is * <a href="http://en.wikipedia.org/wiki/Connectionless";>connectionless</a>. */ boolean isConnectionless(); /** - * Returns {@code true} if the messages exchanged by the service can be + * @return {@code true} if the messages exchanged by the service can be * <a href="http://en.wikipedia.org/wiki/IPv4#Fragmentation_and_reassembly";>fragmented * or reassembled</a> by its underlying transport. */ boolean hasFragmentation(); /** - * Returns the address type of the service. + * @return the address type of the service. */ Class<? extends SocketAddress> getAddressType(); /** - * Returns the set of the allowed message type when you write to an + * @return the set of the allowed message type when you write to an * {@link IoSession} that is managed by the service. */ Set<Class<? extends Object>> getEnvelopeTypes(); /** - * Returns the type of the {@link IoSessionConfig} of the service + * @return the type of the {@link IoSessionConfig} of the service */ Class<? extends IoSessionConfig> getSessionConfigType(); } http://git-wip-us.apache.org/repos/asf/mina/blob/dfbf5071/mina-core/src/main/java/org/apache/mina/core/session/IoSession.java ---------------------------------------------------------------------- diff --git a/mina-core/src/main/java/org/apache/mina/core/session/IoSession.java b/mina-core/src/main/java/org/apache/mina/core/session/IoSession.java index 54bf336..b3eb8a5 100644 --- a/mina-core/src/main/java/org/apache/mina/core/session/IoSession.java +++ b/mina-core/src/main/java/org/apache/mina/core/session/IoSession.java @@ -360,19 +360,19 @@ public interface IoSession { Set<Object> getAttributeKeys(); /** - * @return <code>true</code> if this session is connected with remote peer. + * @return <tt>true</tt> if this session is connected with remote peer. */ boolean isConnected(); /** - * @return <code>true</code> if and only if this session is being closed + * @return <tt>true</tt> if and only if this session is being closed * (but not disconnected yet) or is closed. */ boolean isClosing(); /** - * @return <code>true</code> if the session has started and initialized a SslEngine, - * <code>false</code> if the session is not yet secured (the handshake is not completed) + * @return <tt>true</tt> if the session has started and initialized a SslEngine, + * <tt>false</tt> if the session is not yet secured (the handshake is not completed) * or if SSL is not set for this session, or if SSL is not even an option. */ boolean isSecured(); @@ -435,14 +435,14 @@ public interface IoSession { /** * Is read operation is suspended for this session. * - * @return <code>true</code> if suspended + * @return <tt>true</tt> if suspended */ boolean isReadSuspended(); /** * Is write operation is suspended for this session. * - * @return <code>true</code> if suspended + * @return <tt>true</tt> if suspended */ boolean isWriteSuspended(); @@ -547,25 +547,25 @@ public interface IoSession { /** * @param status The researched idle status - * @return <code>true</code> if this session is idle for the specified + * @return <tt>true</tt> if this session is idle for the specified * {@link IdleStatus}. */ boolean isIdle(IdleStatus status); /** - * @return <code>true</code> if this session is {@link IdleStatus#READER_IDLE}. + * @return <tt>true</tt> if this session is {@link IdleStatus#READER_IDLE}. * @see #isIdle(IdleStatus) */ boolean isReaderIdle(); /** - * @return <code>true</code> if this session is {@link IdleStatus#WRITER_IDLE}. + * @return <tt>true</tt> if this session is {@link IdleStatus#WRITER_IDLE}. * @see #isIdle(IdleStatus) */ boolean isWriterIdle(); /** - * @return <code>true</code> if this session is {@link IdleStatus#BOTH_IDLE}. + * @return <tt>true</tt> if this session is {@link IdleStatus#BOTH_IDLE}. * @see #isIdle(IdleStatus) */ boolean isBothIdle(); http://git-wip-us.apache.org/repos/asf/mina/blob/dfbf5071/mina-core/src/main/java/org/apache/mina/core/write/WriteRequestQueue.java ---------------------------------------------------------------------- diff --git a/mina-core/src/main/java/org/apache/mina/core/write/WriteRequestQueue.java b/mina-core/src/main/java/org/apache/mina/core/write/WriteRequestQueue.java index a047598..1e64234 100644 --- a/mina-core/src/main/java/org/apache/mina/core/write/WriteRequestQueue.java +++ b/mina-core/src/main/java/org/apache/mina/core/write/WriteRequestQueue.java @@ -45,7 +45,7 @@ public interface WriteRequestQueue { /** * Tells if the WriteRequest queue is empty or not for a session * @param session The session to check - * @return <code>true</code> if the writeRequest is empty + * @return <tt>true</tt> if the writeRequest is empty */ boolean isEmpty(IoSession session); http://git-wip-us.apache.org/repos/asf/mina/blob/dfbf5071/mina-core/src/main/java/org/apache/mina/filter/codec/statemachine/ConsumeToDynamicTerminatorDecodingState.java ---------------------------------------------------------------------- diff --git a/mina-core/src/main/java/org/apache/mina/filter/codec/statemachine/ConsumeToDynamicTerminatorDecodingState.java b/mina-core/src/main/java/org/apache/mina/filter/codec/statemachine/ConsumeToDynamicTerminatorDecodingState.java index 091d8b5..0c5ca4b 100644 --- a/mina-core/src/main/java/org/apache/mina/filter/codec/statemachine/ConsumeToDynamicTerminatorDecodingState.java +++ b/mina-core/src/main/java/org/apache/mina/filter/codec/statemachine/ConsumeToDynamicTerminatorDecodingState.java @@ -103,8 +103,8 @@ public abstract class ConsumeToDynamicTerminatorDecodingState implements Decodin * Determines whether the specified <code>byte</code> is a terminator. * * @param b the <code>byte</code> to check. - * @return <code>true</code> if <code>b</code> is a terminator, - * <code>false</code> otherwise. + * @return <tt>true</tt> if <code>b</code> is a terminator, + * <tt>false</tt> otherwise. */ protected abstract boolean isTerminator(byte b); http://git-wip-us.apache.org/repos/asf/mina/blob/dfbf5071/mina-core/src/main/java/org/apache/mina/filter/codec/statemachine/ConsumeToLinearWhitespaceDecodingState.java ---------------------------------------------------------------------- diff --git a/mina-core/src/main/java/org/apache/mina/filter/codec/statemachine/ConsumeToLinearWhitespaceDecodingState.java b/mina-core/src/main/java/org/apache/mina/filter/codec/statemachine/ConsumeToLinearWhitespaceDecodingState.java index 46c5b8a..aa3bb60 100644 --- a/mina-core/src/main/java/org/apache/mina/filter/codec/statemachine/ConsumeToLinearWhitespaceDecodingState.java +++ b/mina-core/src/main/java/org/apache/mina/filter/codec/statemachine/ConsumeToLinearWhitespaceDecodingState.java @@ -28,7 +28,7 @@ package org.apache.mina.filter.codec.statemachine; public abstract class ConsumeToLinearWhitespaceDecodingState extends ConsumeToDynamicTerminatorDecodingState { /** - * @return <code>true</code> if the given byte is a space or a tab + * @return <tt>true</tt> if the given byte is a space or a tab */ @Override protected boolean isTerminator(byte b) { http://git-wip-us.apache.org/repos/asf/mina/blob/dfbf5071/mina-core/src/main/java/org/apache/mina/filter/codec/statemachine/CrLfDecodingState.java ---------------------------------------------------------------------- diff --git a/mina-core/src/main/java/org/apache/mina/filter/codec/statemachine/CrLfDecodingState.java b/mina-core/src/main/java/org/apache/mina/filter/codec/statemachine/CrLfDecodingState.java index 95b236e..c6fd00b 100644 --- a/mina-core/src/main/java/org/apache/mina/filter/codec/statemachine/CrLfDecodingState.java +++ b/mina-core/src/main/java/org/apache/mina/filter/codec/statemachine/CrLfDecodingState.java @@ -25,9 +25,9 @@ import org.apache.mina.filter.codec.ProtocolDecoderOutput; /** * {@link DecodingState} which decodes a single <code>CRLF</code>. - * If it is found, the bytes are consumed and <code>true</code> + * If it is found, the bytes are consumed and <tt>true</tt> * is provided as the product. Otherwise, read bytes are pushed back - * to the stream, and <code>false</code> is provided as the + * to the stream, and <tt>false</tt> is provided as the * product. * Note that if we find a CR but do not find a following LF, we raise * an error. @@ -97,7 +97,7 @@ public abstract class CrLfDecodingState implements DecodingState { /** * Invoked when this state has found a <code>CRLF</code>. * - * @param foundCRLF <code>true</code> if <code>CRLF</code> was found. + * @param foundCRLF <tt>true</tt> if <code>CRLF</code> was found. * @param out the current {@link ProtocolDecoderOutput} used to write * decoded messages. * @return the next state if a state transition was triggered (use http://git-wip-us.apache.org/repos/asf/mina/blob/dfbf5071/mina-core/src/main/java/org/apache/mina/filter/codec/statemachine/SkippingState.java ---------------------------------------------------------------------- diff --git a/mina-core/src/main/java/org/apache/mina/filter/codec/statemachine/SkippingState.java b/mina-core/src/main/java/org/apache/mina/filter/codec/statemachine/SkippingState.java index c2af10f..ca14766 100644 --- a/mina-core/src/main/java/org/apache/mina/filter/codec/statemachine/SkippingState.java +++ b/mina-core/src/main/java/org/apache/mina/filter/codec/statemachine/SkippingState.java @@ -65,7 +65,7 @@ public abstract class SkippingState implements DecodingState { * Called to determine whether the specified byte can be skipped. * * @param b the byte to check. - * @return <code>true</code> if the byte can be skipped. + * @return <tt>true</tt> if the byte can be skipped. */ protected abstract boolean canSkip(byte b); http://git-wip-us.apache.org/repos/asf/mina/blob/dfbf5071/mina-core/src/main/java/org/apache/mina/filter/ssl/SslContextFactory.java ---------------------------------------------------------------------- diff --git a/mina-core/src/main/java/org/apache/mina/filter/ssl/SslContextFactory.java b/mina-core/src/main/java/org/apache/mina/filter/ssl/SslContextFactory.java index fea4d0f..b66610b 100644 --- a/mina-core/src/main/java/org/apache/mina/filter/ssl/SslContextFactory.java +++ b/mina-core/src/main/java/org/apache/mina/filter/ssl/SslContextFactory.java @@ -187,7 +187,7 @@ public class SslContextFactory { } /** - * If this is set to <code>true</code> while no {@link KeyManagerFactory} + * If this is set to <tt>true</tt> while no {@link KeyManagerFactory} * has been set using {@link #setKeyManagerFactory(KeyManagerFactory)} and * no algorithm has been set using * {@link #setKeyManagerFactoryAlgorithm(String)} the default algorithm @@ -195,21 +195,21 @@ public class SslContextFactory { * The default value of this property is <tt>true</tt>. * * @param useDefault - * <code>true</code> or <code>false</code>. + * <tt>true</tt> or <tt>false</tt>. */ public void setKeyManagerFactoryAlgorithmUseDefault(boolean useDefault) { this.keyManagerFactoryAlgorithmUseDefault = useDefault; } /** - * If this is set to <code>true</code> while no {@link TrustManagerFactory} + * If this is set to <tt>true</tt> while no {@link TrustManagerFactory} * has been set using {@link #setTrustManagerFactory(TrustManagerFactory)} and * no algorithm has been set using * {@link #setTrustManagerFactoryAlgorithm(String)} the default algorithm * return by {@link TrustManagerFactory#getDefaultAlgorithm()} will be used. * The default value of this property is <tt>true</tt>. * - * @param useDefault <code>true</code> or <code>false</code>. + * @param useDefault <tt>true</tt> or <tt>false</tt>. */ public void setTrustManagerFactoryAlgorithmUseDefault(boolean useDefault) { this.trustManagerFactoryAlgorithmUseDefault = useDefault; @@ -237,7 +237,7 @@ public class SslContextFactory { * If this property isn't set while no {@link KeyManagerFactory} has been * set using {@link #setKeyManagerFactory(KeyManagerFactory)} and * {@link #setKeyManagerFactoryAlgorithmUseDefault(boolean)} has been set to - * <code>true</code> the value returned + * <tt>true</tt> the value returned * by {@link KeyManagerFactory#getDefaultAlgorithm()} will be used instead. * * @param algorithm the algorithm to use. @@ -314,7 +314,7 @@ public class SslContextFactory { * If this property isn't set while no {@link TrustManagerFactory} has been * set using {@link #setTrustManagerFactory(TrustManagerFactory)} and * {@link #setTrustManagerFactoryAlgorithmUseDefault(boolean)} has been set to - * <code>true</code> the value returned + * <tt>true</tt> the value returned * by {@link TrustManagerFactory#getDefaultAlgorithm()} will be used instead. * * @param algorithm the algorithm to use. http://git-wip-us.apache.org/repos/asf/mina/blob/dfbf5071/mina-core/src/main/java/org/apache/mina/filter/ssl/SslFilter.java ---------------------------------------------------------------------- diff --git a/mina-core/src/main/java/org/apache/mina/filter/ssl/SslFilter.java b/mina-core/src/main/java/org/apache/mina/filter/ssl/SslFilter.java index 603a3d7..77747eb 100644 --- a/mina-core/src/main/java/org/apache/mina/filter/ssl/SslFilter.java +++ b/mina-core/src/main/java/org/apache/mina/filter/ssl/SslFilter.java @@ -180,7 +180,7 @@ public class SslFilter extends IoFilterAdapter { /** * Creates a new SSL filter using the specified {@link SSLContext}. - * If the <code>autostart</code> flag is set to <code>true</code>, the + * If the <code>autostart</code> flag is set to <tt>true</tt>, the * handshake will start immediately. */ public SslFilter(SSLContext sslContext, boolean autoStart) { http://git-wip-us.apache.org/repos/asf/mina/blob/dfbf5071/mina-core/src/main/java/org/apache/mina/proxy/AbstractProxyLogicHandler.java ---------------------------------------------------------------------- diff --git a/mina-core/src/main/java/org/apache/mina/proxy/AbstractProxyLogicHandler.java b/mina-core/src/main/java/org/apache/mina/proxy/AbstractProxyLogicHandler.java index 5f4b2f9..d9e866e 100644 --- a/mina-core/src/main/java/org/apache/mina/proxy/AbstractProxyLogicHandler.java +++ b/mina-core/src/main/java/org/apache/mina/proxy/AbstractProxyLogicHandler.java @@ -112,7 +112,7 @@ public abstract class AbstractProxyLogicHandler implements ProxyLogicHandler { } /** - * Returns <code>true</code> if handshaking is complete and + * Returns <tt>true</tt> if handshaking is complete and * data can be sent through the proxy. */ public boolean isHandshakeComplete() { http://git-wip-us.apache.org/repos/asf/mina/blob/dfbf5071/mina-core/src/main/java/org/apache/mina/proxy/ProxyLogicHandler.java ---------------------------------------------------------------------- diff --git a/mina-core/src/main/java/org/apache/mina/proxy/ProxyLogicHandler.java b/mina-core/src/main/java/org/apache/mina/proxy/ProxyLogicHandler.java index 65681d8..1e29527 100644 --- a/mina-core/src/main/java/org/apache/mina/proxy/ProxyLogicHandler.java +++ b/mina-core/src/main/java/org/apache/mina/proxy/ProxyLogicHandler.java @@ -34,7 +34,7 @@ public interface ProxyLogicHandler { /** * Tests if handshake process is complete. * - * @return <code>true</code> if handshaking is complete and + * @return <tt>true</tt> if handshaking is complete and * data can be sent through the proxy, false otherwise. */ boolean isHandshakeComplete(); http://git-wip-us.apache.org/repos/asf/mina/blob/dfbf5071/mina-core/src/main/java/org/apache/mina/proxy/utils/StringUtilities.java ---------------------------------------------------------------------- diff --git a/mina-core/src/main/java/org/apache/mina/proxy/utils/StringUtilities.java b/mina-core/src/main/java/org/apache/mina/proxy/utils/StringUtilities.java index 03bbe88..c3b8687 100644 --- a/mina-core/src/main/java/org/apache/mina/proxy/utils/StringUtilities.java +++ b/mina-core/src/main/java/org/apache/mina/proxy/utils/StringUtilities.java @@ -234,7 +234,7 @@ public class StringUtilities { * Note that we're checking individual bytes instead of CRLF * * @param b the byte to check - * @return <code>true</code> if it's a linear white space + * @return <tt>true</tt> if it's a linear white space */ public static boolean isLws(byte b) { switch (b) { http://git-wip-us.apache.org/repos/asf/mina/blob/dfbf5071/mina-core/src/main/java/org/apache/mina/transport/socket/nio/NioDatagramSessionConfig.java ---------------------------------------------------------------------- diff --git a/mina-core/src/main/java/org/apache/mina/transport/socket/nio/NioDatagramSessionConfig.java b/mina-core/src/main/java/org/apache/mina/transport/socket/nio/NioDatagramSessionConfig.java index 7e3e93b..552feaf 100644 --- a/mina-core/src/main/java/org/apache/mina/transport/socket/nio/NioDatagramSessionConfig.java +++ b/mina-core/src/main/java/org/apache/mina/transport/socket/nio/NioDatagramSessionConfig.java @@ -85,7 +85,7 @@ class NioDatagramSessionConfig extends AbstractDatagramSessionConfig { /** * Tells if SO_BROADCAST is enabled. * - * @return <code>true</code> if SO_BROADCAST is enabled + * @return <tt>true</tt> if SO_BROADCAST is enabled * @throws RuntimeIoException If the socket is closed or if we get an * {@link SocketException} */ @@ -134,7 +134,7 @@ class NioDatagramSessionConfig extends AbstractDatagramSessionConfig { /** * Tells if SO_REUSEADDR is enabled. * - * @return <code>true</code> if SO_REUSEADDR is enabled + * @return <tt>true</tt> if SO_REUSEADDR is enabled * @throws RuntimeIoException If the socket is closed or if we get an * {@link SocketException} */ http://git-wip-us.apache.org/repos/asf/mina/blob/dfbf5071/mina-core/src/main/java/org/apache/mina/transport/socket/nio/NioSocketAcceptor.java ---------------------------------------------------------------------- diff --git a/mina-core/src/main/java/org/apache/mina/transport/socket/nio/NioSocketAcceptor.java b/mina-core/src/main/java/org/apache/mina/transport/socket/nio/NioSocketAcceptor.java index 77f218c..8f8b79b 100644 --- a/mina-core/src/main/java/org/apache/mina/transport/socket/nio/NioSocketAcceptor.java +++ b/mina-core/src/main/java/org/apache/mina/transport/socket/nio/NioSocketAcceptor.java @@ -331,7 +331,7 @@ implements SocketAcceptor { /** * Tells if there are more SockectChannel left in the iterator - * @return <code>true</code> if there is at least one more + * @return <tt>true</tt> if there is at least one more * SockectChannel object to read */ public boolean hasNext() { http://git-wip-us.apache.org/repos/asf/mina/blob/dfbf5071/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 1671fce..a6774dd 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 @@ -35,7 +35,7 @@ public interface HttpRequest extends HttpMessage { * Determines whether this request contains at least one parameter with the specified name * * @param name The parameter name - * @return <code>true</code> if this request contains at least one parameter with the specified name + * @return <tt>true</tt> if this request contains at least one parameter with the specified name */ boolean containsParameter(String name); http://git-wip-us.apache.org/repos/asf/mina/blob/dfbf5071/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 b620cd3..dcc9eb6 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 @@ -120,7 +120,7 @@ public class StateMachineProxyBuilder { * an exception or be silently ignored. The default is to raise an * exception. * - * @param b <code>true</code> to ignore context lookup failures. + * @param b <tt>true</tt> to ignore context lookup failures. * @return this {@link StateMachineProxyBuilder} for method chaining. */ public StateMachineProxyBuilder setIgnoreUnhandledEvents(boolean b) { @@ -133,7 +133,7 @@ public class StateMachineProxyBuilder { * to a method call on the proxy produced by this builder will raise an * exception or be silently ignored. The default is to raise an exception. * - * @param b <code>true</code> to ignore context lookup failures. + * @param b <tt>true</tt> to ignore context lookup failures. * @return this {@link StateMachineProxyBuilder} for method chaining. */ public StateMachineProxyBuilder setIgnoreStateContextLookupFailure(boolean b) { http://git-wip-us.apache.org/repos/asf/mina/blob/dfbf5071/mina-statemachine/src/main/java/org/apache/mina/statemachine/context/AbstractStateContextLookup.java ---------------------------------------------------------------------- diff --git a/mina-statemachine/src/main/java/org/apache/mina/statemachine/context/AbstractStateContextLookup.java b/mina-statemachine/src/main/java/org/apache/mina/statemachine/context/AbstractStateContextLookup.java index a024e2d..12d555e 100644 --- a/mina-statemachine/src/main/java/org/apache/mina/statemachine/context/AbstractStateContextLookup.java +++ b/mina-statemachine/src/main/java/org/apache/mina/statemachine/context/AbstractStateContextLookup.java @@ -23,7 +23,7 @@ package org.apache.mina.statemachine.context; * Abstract {@link StateContextLookup} implementation. The {@link #lookup(Object[])} * method will loop through the event arguments and call the {@link #supports(Class)} * method for each of them. The first argument that this method returns - * <code>true</code> for will be passed to the abstract {@link #lookup(Object)} + * <tt>true</tt> for will be passed to the abstract {@link #lookup(Object)} * method which should try to extract a {@link StateContext} from the argument. * If none is found a new {@link StateContext} will be created and stored in the * event argument using the {@link #store(Object, StateContext)} method. @@ -63,7 +63,7 @@ public abstract class AbstractStateContextLookup implements StateContextLookup { /** * Extracts a {@link StateContext} from the specified event argument which * is an instance of a class {@link #supports(Class)} returns - * <code>true</code> for. + * <tt>true</tt> for. * * @param eventArg the event argument. * @return the {@link StateContext}. @@ -73,7 +73,7 @@ public abstract class AbstractStateContextLookup implements StateContextLookup { /** * Stores a new {@link StateContext} in the specified event argument which * is an instance of a class {@link #supports(Class)} returns - * <code>true</code> for. + * <tt>true</tt> for. * * @param eventArg the event argument. * @param context the {@link StateContext} to be stored. @@ -81,12 +81,12 @@ public abstract class AbstractStateContextLookup implements StateContextLookup { protected abstract void store(Object eventArg, StateContext context); /** - * Must return <code>true</code> for any {@link Class} that this + * Must return <tt>true</tt> for any {@link Class} that this * {@link StateContextLookup} can use to store and lookup * {@link StateContext} objects. * * @param c the class. - * @return <code>true</code> or <code>false</code>. + * @return <tt>true</tt> or <tt>false</tt>. */ protected abstract boolean supports(Class<?> c); } http://git-wip-us.apache.org/repos/asf/mina/blob/dfbf5071/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 e7ebfd5..183d876 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 @@ -41,7 +41,7 @@ public abstract class AbstractSelfTransition implements SelfTransition { /** * Executes this {@link SelfTransition}. * - * @return <code>true</code> if the {@link SelfTransition} has been executed + * @return <tt>true</tt> if the {@link SelfTransition} has been executed * successfully */ protected abstract boolean doExecute(StateContext stateContext, State state); http://git-wip-us.apache.org/repos/asf/mina/blob/dfbf5071/mina-statemachine/src/main/java/org/apache/mina/statemachine/transition/AbstractTransition.java ---------------------------------------------------------------------- diff --git a/mina-statemachine/src/main/java/org/apache/mina/statemachine/transition/AbstractTransition.java b/mina-statemachine/src/main/java/org/apache/mina/statemachine/transition/AbstractTransition.java index 6817f08..27f2478 100644 --- a/mina-statemachine/src/main/java/org/apache/mina/statemachine/transition/AbstractTransition.java +++ b/mina-statemachine/src/main/java/org/apache/mina/statemachine/transition/AbstractTransition.java @@ -79,9 +79,9 @@ public abstract class AbstractTransition implements Transition { * already made sure that that is the case. * * @param event the current {@link Event}. - * @return <code>true</code> if the {@link Transition} has been executed + * @return <tt>true</tt> if the {@link Transition} has been executed * successfully and the {@link StateMachine} should move to the - * next {@link State}. <code>false</code> otherwise. + * next {@link State}. <tt>false</tt> otherwise. */ protected abstract boolean doExecute(Event event); http://git-wip-us.apache.org/repos/asf/mina/blob/dfbf5071/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 e5fe95e..81a5ce1 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,8 +32,8 @@ public interface SelfTransition { /** * Executes this {@link SelfTransition}. * - * @return <code>true</code> if the {@link SelfTransition} was executed, - * <code>false</code> otherwise. + * @return <tt>true</tt> if the {@link SelfTransition} was executed, + * <tt>false</tt> otherwise. */ boolean execute(StateContext stateContext, State state); http://git-wip-us.apache.org/repos/asf/mina/blob/dfbf5071/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 4da69c2..c0efaf7 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 @@ -34,18 +34,18 @@ public interface Transition { * Executes this {@link Transition}. It is the responsibility of this * {@link Transition} to determine whether it actually applies for the * specified {@link Event}. If this {@link Transition} doesn't apply - * nothing should be executed and <code>false</code> must be returned. + * nothing should be executed and <tt>false</tt> must be returned. * * @param event the current {@link Event}. - * @return <code>true</code> if the {@link Transition} was executed, - * <code>false</code> otherwise. + * @return <tt>true</tt> if the {@link Transition} was executed, + * <tt>false</tt> otherwise. */ boolean execute(Event event); /** * Returns the {@link State} which the {@link StateMachine} should move to * if this {@link Transition} is taken and {@link #execute(Event)} returns - * <code>true</code>. + * <tt>true</tt>. * * @return the next {@link State} or <code>null</code> if this * {@link Transition} is a loopback {@link Transition}.
