Comment clean up as advised

This commit is contained in:
Trustin Lee 2008-11-14 07:45:53 +00:00
parent 927aaf8d12
commit 09ef8e8964
40 changed files with 76 additions and 76 deletions

View File

@ -248,7 +248,7 @@ public class Bootstrap {
/** /**
* Sets an option with the specified key and value. If there's already * Sets an option with the specified key and value. If there's already
* an option with the same key, it's replaced with the new value. If the * an option with the same key, it is replaced with the new value. If the
* specified value is {@code null}, an existing option with the specified * specified value is {@code null}, an existing option with the specified
* key is removed. * key is removed.
*/ */

View File

@ -86,7 +86,7 @@ import org.jboss.netty.channel.SimpleChannelHandler;
* *
* <h3>Configuring a parent channel pipeline</h3> * <h3>Configuring a parent channel pipeline</h3>
* *
* It is rare to configure the pipeline of a parent channel because what it's * It is rare to configure the pipeline of a parent channel because what it is
* supposed to do is very typical. However, you might want to add a handler * supposed to do is very typical. However, you might want to add a handler
* to deal with some special needs such as degrading the process * to deal with some special needs such as degrading the process
* <a href="http://en.wikipedia.org/wiki/User_identifier_(Unix)">UID</a> from * <a href="http://en.wikipedia.org/wiki/User_identifier_(Unix)">UID</a> from

View File

@ -152,7 +152,7 @@ import java.util.NoSuchElementException;
* *
* You can set both {@link #readerIndex() readerIndex} and * You can set both {@link #readerIndex() readerIndex} and
* {@link #writerIndex() writerIndex} to {@code 0} by calling {@link #clear()}. * {@link #writerIndex() writerIndex} to {@code 0} by calling {@link #clear()}.
* It doesn't clear the buffer content (e.g. filling with {@code 0}) but just * It does not clear the buffer content (e.g. filling with {@code 0}) but just
* clears the two pointers. Please also note that the semantic of this * clears the two pointers. Please also note that the semantic of this
* operation is different from {@link ByteBuffer#clear()}. * operation is different from {@link ByteBuffer#clear()}.
* *
@ -505,7 +505,7 @@ public interface ChannelBuffer extends Comparable<ChannelBuffer> {
* {@link #getBytes(int, ChannelBuffer, int, int)}, except that this * {@link #getBytes(int, ChannelBuffer, int, int)}, except that this
* method increases the {@code writerIndex} of the destination by the * method increases the {@code writerIndex} of the destination by the
* number of the transferred bytes while * number of the transferred bytes while
* {@link #getBytes(int, ChannelBuffer, int, int)} doesn't. * {@link #getBytes(int, ChannelBuffer, int, int)} does not.
* *
* @throws IndexOutOfBoundsException * @throws IndexOutOfBoundsException
* if the specified {@code index} is less than {@code 0} or * if the specified {@code index} is less than {@code 0} or
@ -520,7 +520,7 @@ public interface ChannelBuffer extends Comparable<ChannelBuffer> {
* with {@link #getBytes(int, ChannelBuffer, int, int)}, except that this * with {@link #getBytes(int, ChannelBuffer, int, int)}, except that this
* method increases the {@code writerIndex} of the destination by the * method increases the {@code writerIndex} of the destination by the
* number of the transferred bytes while * number of the transferred bytes while
* {@link #getBytes(int, ChannelBuffer, int, int)} doesn't. * {@link #getBytes(int, ChannelBuffer, int, int)} does not.
* *
* @param length the number of bytes to transfer * @param length the number of bytes to transfer
* *
@ -679,7 +679,7 @@ public interface ChannelBuffer extends Comparable<ChannelBuffer> {
* {@link #setBytes(int, ChannelBuffer, int, int)}, except that this * {@link #setBytes(int, ChannelBuffer, int, int)}, except that this
* method increases the {@code readerIndex} of the source buffer by * method increases the {@code readerIndex} of the source buffer by
* the number of the transferred bytes while * the number of the transferred bytes while
* {@link #getBytes(int, ChannelBuffer, int, int)} doesn't. * {@link #getBytes(int, ChannelBuffer, int, int)} does not.
* *
* @throws IndexOutOfBoundsException * @throws IndexOutOfBoundsException
* if the specified {@code index} is less than {@code 0} or * if the specified {@code index} is less than {@code 0} or
@ -694,7 +694,7 @@ public interface ChannelBuffer extends Comparable<ChannelBuffer> {
* with {@link #setBytes(int, ChannelBuffer, int, int)}, except that this * with {@link #setBytes(int, ChannelBuffer, int, int)}, except that this
* method increases the {@code readerIndex} of the source buffer by * method increases the {@code readerIndex} of the source buffer by
* the number of the transferred bytes while * the number of the transferred bytes while
* {@link #getBytes(int, ChannelBuffer, int, int)} doesn't. * {@link #getBytes(int, ChannelBuffer, int, int)} does not.
* *
* @param length the number of bytes to transfer * @param length the number of bytes to transfer
* *
@ -955,7 +955,7 @@ public interface ChannelBuffer extends Comparable<ChannelBuffer> {
* {@link #readBytes(ChannelBuffer, int, int)}, except that this method * {@link #readBytes(ChannelBuffer, int, int)}, except that this method
* increases the {@code writerIndex} of the destination by the number of * increases the {@code writerIndex} of the destination by the number of
* the transferred bytes while {@link #readBytes(ChannelBuffer, int, int)} * the transferred bytes while {@link #readBytes(ChannelBuffer, int, int)}
* doesn't. * does not.
* *
* @throws IndexOutOfBoundsException * @throws IndexOutOfBoundsException
* if {@code dst.writableBytes} is greater than * if {@code dst.writableBytes} is greater than
@ -970,7 +970,7 @@ public interface ChannelBuffer extends Comparable<ChannelBuffer> {
* is basically same with {@link #readBytes(ChannelBuffer, int, int)}, * is basically same with {@link #readBytes(ChannelBuffer, int, int)},
* except that this method increases the {@code writerIndex} of the * except that this method increases the {@code writerIndex} of the
* destination by the number of the transferred bytes (= {@code length}) * destination by the number of the transferred bytes (= {@code length})
* while {@link #readBytes(ChannelBuffer, int, int)} doesn't. * while {@link #readBytes(ChannelBuffer, int, int)} does not.
* *
* @throws IndexOutOfBoundsException * @throws IndexOutOfBoundsException
* if {@code length} is greater than {@code this.readableBytes} or * if {@code length} is greater than {@code this.readableBytes} or
@ -1135,7 +1135,7 @@ public interface ChannelBuffer extends Comparable<ChannelBuffer> {
* {@link #writeBytes(ChannelBuffer, int, int)}, except that this method * {@link #writeBytes(ChannelBuffer, int, int)}, except that this method
* increases the {@code readerIndex} of the source buffer by the number of * increases the {@code readerIndex} of the source buffer by the number of
* the transferred bytes while {@link #writeBytes(ChannelBuffer, int, int)} * the transferred bytes while {@link #writeBytes(ChannelBuffer, int, int)}
* doesn't. * does not.
* *
* @throws IndexOutOfBoundsException * @throws IndexOutOfBoundsException
* if {@code src.readableBytes} is greater than * if {@code src.readableBytes} is greater than
@ -1151,7 +1151,7 @@ public interface ChannelBuffer extends Comparable<ChannelBuffer> {
* is basically same with {@link #writeBytes(ChannelBuffer, int, int)}, * is basically same with {@link #writeBytes(ChannelBuffer, int, int)},
* except that this method increases the {@code readerIndex} of the source * except that this method increases the {@code readerIndex} of the source
* buffer by the number of the transferred bytes (= {@code length}) while * buffer by the number of the transferred bytes (= {@code length}) while
* {@link #writeBytes(ChannelBuffer, int, int)} doesn't. * {@link #writeBytes(ChannelBuffer, int, int)} does not.
* *
* @param length the number of bytes to transfer * @param length the number of bytes to transfer
* *
@ -1287,14 +1287,14 @@ public interface ChannelBuffer extends Comparable<ChannelBuffer> {
/** /**
* Returns a copy of this buffer's readable bytes. Modifying the content * Returns a copy of this buffer's readable bytes. Modifying the content
* of the returned buffer or this buffer doesn't affect each other at all. * of the returned buffer or this buffer does not affect each other at all.
* This method is identical to {@code buf.copy(buf.readerIndex(), buf.readableBytes())}. * This method is identical to {@code buf.copy(buf.readerIndex(), buf.readableBytes())}.
*/ */
ChannelBuffer copy(); ChannelBuffer copy();
/** /**
* Returns a copy of this buffer's sub-region. Modifying the content of * Returns a copy of this buffer's sub-region. Modifying the content of
* the returned buffer or this buffer doesn't affect each other at all. * the returned buffer or this buffer does not affect each other at all.
*/ */
ChannelBuffer copy(int index, int length); ChannelBuffer copy(int index, int length);
@ -1414,7 +1414,7 @@ public interface ChannelBuffer extends Comparable<ChannelBuffer> {
* <li>the size of the contents of the two buffers are same and</li> * <li>the size of the contents of the two buffers are same and</li>
* <li>every single byte of the content of the two buffers are same.</li> * <li>every single byte of the content of the two buffers are same.</li>
* </ul> * </ul>
* Please note that it doesn't compare {@link #readerIndex()} nor * Please note that it does not compare {@link #readerIndex()} nor
* {@link #writerIndex()}. This method also returns {@code false} for * {@link #writerIndex()}. This method also returns {@code false} for
* {@code null} and an object which is not an instance of * {@code null} and an object which is not an instance of
* {@link ChannelBuffer} type. * {@link ChannelBuffer} type.
@ -1430,7 +1430,7 @@ public interface ChannelBuffer extends Comparable<ChannelBuffer> {
int compareTo(ChannelBuffer buffer); int compareTo(ChannelBuffer buffer);
/** /**
* Returns the string representation of this buffer. This method doesn't * Returns the string representation of this buffer. This method does not
* necessarily return the whole content of the buffer but returns * necessarily return the whole content of the buffer but returns
* the values of the key properties such as {@link #readerIndex()}, * the values of the key properties such as {@link #readerIndex()},
* {@link #writerIndex()} and {@link #capacity()}. * {@link #writerIndex()} and {@link #capacity()}.

View File

@ -72,7 +72,7 @@ import java.nio.charset.UnsupportedCharsetException;
* Copied buffer is a deep copy of one or more existing byte arrays, byte * Copied buffer is a deep copy of one or more existing byte arrays, byte
* buffers or a string. Unlike a wrapped buffer, there's no shared data * buffers or a string. Unlike a wrapped buffer, there's no shared data
* between the original data and the copied buffer. Various copy methods are * between the original data and the copied buffer. Various copy methods are
* provided and their name is all {@code copiedBuffer()}. It's also convenient * provided and their name is all {@code copiedBuffer()}. It is also convenient
* to use this operation to merge multiple buffers into one buffer. * to use this operation to merge multiple buffers into one buffer.
* *
* <h3>Miscellaneous utility methods</h3> * <h3>Miscellaneous utility methods</h3>

View File

@ -24,7 +24,7 @@ package org.jboss.netty.buffer;
/** /**
* The common interface for buffer wrappers and derived buffers. Most users won't * The common interface for buffer wrappers and derived buffers. Most users won't
* need to use this interface. It's used internally in most cases. * need to use this interface. It is used internally in most cases.
* *
* @author The Netty Project (netty-dev@lists.jboss.org) * @author The Netty Project (netty-dev@lists.jboss.org)
* @author Trustin Lee (tlee@redhat.com) * @author Trustin Lee (tlee@redhat.com)

View File

@ -26,7 +26,7 @@ import java.net.SocketAddress;
/** /**
* A skeletal server-side {@link Channel} implementation. A server-side * A skeletal server-side {@link Channel} implementation. A server-side
* {@link Channel} doesn't allow the following operations: * {@link Channel} does not allow the following operations:
* <ul> * <ul>
* <li>{@link #connect(SocketAddress)}</li> * <li>{@link #connect(SocketAddress)}</li>
* <li>{@link #disconnect()}</li> * <li>{@link #disconnect()}</li>

View File

@ -105,7 +105,7 @@ public interface Channel {
* Returns the parent of this channel. * Returns the parent of this channel.
* *
* @return the parent channel. * @return the parent channel.
* {@code null} if this channel doesn't have a parent channel. * {@code null} if this channel does not have a parent channel.
*/ */
Channel getParent(); Channel getParent();

View File

@ -81,7 +81,7 @@ public interface ChannelConfig {
/** /**
* Returns the {@link ChannelPipelineFactory} which will be used when * Returns the {@link ChannelPipelineFactory} which will be used when
* a child channel is created. If the {@link Channel} doesn't create * a child channel is created. If the {@link Channel} does not create
* a child channel, this property is not used at all, and therefore will * a child channel, this property is not used at all, and therefore will
* be ignored. * be ignored.
*/ */
@ -89,7 +89,7 @@ public interface ChannelConfig {
/** /**
* Sets the {@link ChannelPipelineFactory} which will be used when * Sets the {@link ChannelPipelineFactory} which will be used when
* a child channel is created. If the {@link Channel} doesn't create * a child channel is created. If the {@link Channel} does not create
* a child channel, this property is not used at all, and therefore will * a child channel, this property is not used at all, and therefore will
* be ignored. * be ignored.
*/ */
@ -97,7 +97,7 @@ public interface ChannelConfig {
/** /**
* Returns the connect timeout of the channel in milliseconds. If the * Returns the connect timeout of the channel in milliseconds. If the
* {@link Channel} doesn't support connect operation, this property is not * {@link Channel} does not support connect operation, this property is not
* used at all, and therefore will be ignored. * used at all, and therefore will be ignored.
* *
* @return the connect timeout in milliseconds. {@code 0} if disabled. * @return the connect timeout in milliseconds. {@code 0} if disabled.
@ -106,7 +106,7 @@ public interface ChannelConfig {
/** /**
* Sets the connect timeout of the channel in milliseconds. If the * Sets the connect timeout of the channel in milliseconds. If the
* {@link Channel} doesn't support connect operation, this property is not * {@link Channel} does not support connect operation, this property is not
* used at all, and therefore will be ignored. * used at all, and therefore will be ignored.
* *
* @param connectTimeoutMillis the connect timeout in milliseconds. * @param connectTimeoutMillis the connect timeout in milliseconds.
@ -117,7 +117,7 @@ public interface ChannelConfig {
/** /**
* Returns the write timeout of the channel in milliseconds. If a write * Returns the write timeout of the channel in milliseconds. If a write
* operation is not completed within the write timeout, an * operation is not completed within the write timeout, an
* {@link IOException} will be raised. If the {@link Channel} doesn't * {@link IOException} will be raised. If the {@link Channel} does not
* support write operation, this property is not used at all, and therefore * support write operation, this property is not used at all, and therefore
* will be ignored. * will be ignored.
* *
@ -128,7 +128,7 @@ public interface ChannelConfig {
/** /**
* Sets the write timeout of the channel in milliseconds. If a write * Sets the write timeout of the channel in milliseconds. If a write
* operation is not completed within the write timeout, an * operation is not completed within the write timeout, an
* {@link IOException} will be raised. If the {@link Channel} doesn't * {@link IOException} will be raised. If the {@link Channel} does not
* support write operation, this property is not used at all, and therefore * support write operation, this property is not used at all, and therefore
* will be ignored. * will be ignored.
* *

View File

@ -79,7 +79,7 @@ import java.net.SocketAddress;
* <p> * <p>
* Other event types and conditions which were not addressed here will be * Other event types and conditions which were not addressed here will be
* ignored and discarded. Please note that there's no {@code "open"} in the * ignored and discarded. Please note that there's no {@code "open"} in the
* table. It's because a {@link Channel} is always open when it's created * table. It is because a {@link Channel} is always open when it is created
* by a {@link ChannelFactory}. * by a {@link ChannelFactory}.
* *
* <h4>Additional resources worth reading</h4> * <h4>Additional resources worth reading</h4>

View File

@ -53,7 +53,7 @@ import org.jboss.netty.handler.ssl.SslHandler;
* or a {@link ChannelDownstreamHandler} and be forwarded to the next or * or a {@link ChannelDownstreamHandler} and be forwarded to the next or
* previous handler by calling {@link ChannelHandlerContext#sendUpstream(ChannelEvent)} * previous handler by calling {@link ChannelHandlerContext#sendUpstream(ChannelEvent)}
* or {@link ChannelHandlerContext#sendDownstream(ChannelEvent)}. The meaning * or {@link ChannelHandlerContext#sendDownstream(ChannelEvent)}. The meaning
* of the event is interpreted somewhat differently depending on whether it's * of the event is interpreted somewhat differently depending on whether it is
* going upstream or going downstream. Please refer to {@link ChannelEvent} for * going upstream or going downstream. Please refer to {@link ChannelEvent} for
* more explanation. * more explanation.
* *
@ -269,7 +269,7 @@ public interface ChannelPipeline {
* this pipeline. * this pipeline.
* *
* @throws NoSuchElementException * @throws NoSuchElementException
* if the specified old handler doesn't exist in this pipeline * if the specified old handler does not exist in this pipeline
* @throws IllegalArgumentException * @throws IllegalArgumentException
* if a handler with the specified new name already exists in this * if a handler with the specified new name already exists in this
* pipeline, except for the handler to be replaced * pipeline, except for the handler to be replaced
@ -286,7 +286,7 @@ public interface ChannelPipeline {
* @return the removed handler * @return the removed handler
* *
* @throws NoSuchElementException * @throws NoSuchElementException
* if the handler with the specified old name doesn't exist in this pipeline * if the handler with the specified old name does not exist in this pipeline
* @throws IllegalArgumentException * @throws IllegalArgumentException
* if a handler with the specified new name already exists in this * if a handler with the specified new name already exists in this
* pipeline, except for the handler to be replaced * pipeline, except for the handler to be replaced
@ -303,7 +303,7 @@ public interface ChannelPipeline {
* @return the removed handler * @return the removed handler
* *
* @throws NoSuchElementException * @throws NoSuchElementException
* if the handler of the specified old handler type doesn't exist * if the handler of the specified old handler type does not exist
* in this pipeline * in this pipeline
* @throws IllegalArgumentException * @throws IllegalArgumentException
* if a handler with the specified new name already exists in this * if a handler with the specified new name already exists in this

View File

@ -37,7 +37,7 @@ import java.lang.annotation.Target;
* will be warned in runtime. Only two values are allowed for this annotation: * will be warned in runtime. Only two values are allowed for this annotation:
* {@code "all"} and {@code "one"}. * {@code "all"} and {@code "one"}.
* <p> * <p>
* Please note that this annotation doesn't prevent a handler annotated with * Please note that this annotation does not prevent a handler annotated with
* the value {@code "one"} from being added to more than one pipeline. This * the value {@code "one"} from being added to more than one pipeline. This
* annotation is used for documentation purpose only. * annotation is used for documentation purpose only.
* *

View File

@ -26,7 +26,7 @@ package org.jboss.netty.channel;
* Creates a new {@link ChannelPipeline} for a new {@link Channel}. * Creates a new {@link ChannelPipeline} for a new {@link Channel}.
* <p> * <p>
* This interface was introduced to initialize the {@link ChannelPipeline} of * This interface was introduced to initialize the {@link ChannelPipeline} of
* the child channel accepted by a server-side, but it's safe to use it for * the child channel accepted by a server-side, but it is safe to use it for
* any other purposes. * any other purposes.
* *
* @author The Netty Project (netty-dev@lists.jboss.org) * @author The Netty Project (netty-dev@lists.jboss.org)

View File

@ -162,7 +162,7 @@ import org.jboss.netty.handler.execution.OrderedMemoryAwareThreadPoolExecutor;
* If there's no {@link ExecutionHandler} in the {@link ChannelPipeline}, * If there's no {@link ExecutionHandler} in the {@link ChannelPipeline},
* {@link #handleUpstream(ChannelHandlerContext, ChannelEvent) handleUpstream} * {@link #handleUpstream(ChannelHandlerContext, ChannelEvent) handleUpstream}
* will be invoked sequentially by the same thread (i.e. an I/O thread). * will be invoked sequentially by the same thread (i.e. an I/O thread).
* Please note that this doesn't necessarily mean that there's a dedicated * Please note that this does not necessarily mean that there's a dedicated
* thread per {@link Channel}; the I/O thread of some transport can serve more * thread per {@link Channel}; the I/O thread of some transport can serve more
* than one {@link Channel} (e.g. NIO transport), while the I/O thread of * than one {@link Channel} (e.g. NIO transport), while the I/O thread of
* other transports can serve only one (e.g. OIO transport). * other transports can serve only one (e.g. OIO transport).

View File

@ -196,7 +196,7 @@ public class Channels {
* Sends a {@code "channelOpen"} event to the next * Sends a {@code "channelOpen"} event to the next
* {@link ChannelUpstreamHandler} in the {@link ChannelPipeline} where * {@link ChannelUpstreamHandler} in the {@link ChannelPipeline} where
* the specified {@link ChannelHandlerContext} belongs. Please note that * the specified {@link ChannelHandlerContext} belongs. Please note that
* this method doesn't send a {@code "childChannelOpen"} event unlike * this method does not send a {@code "childChannelOpen"} event unlike
* {@link #fireChannelOpen(Channel)} method. * {@link #fireChannelOpen(Channel)} method.
*/ */
public static void fireChannelOpen( public static void fireChannelOpen(

View File

@ -555,7 +555,7 @@ public class DefaultChannelPipeline implements ChannelPipeline {
if (coverage == null) { if (coverage == null) {
logger.warn( logger.warn(
"Handler '" + handler.getClass().getName() + "Handler '" + handler.getClass().getName() +
"' doesn't have a '" + "' does not have a '" +
ChannelPipelineCoverage.class.getSimpleName() + ChannelPipelineCoverage.class.getSimpleName() +
"' annotation with its class declaration. " + "' annotation with its class declaration. " +
"It is recommended to add the annotation to tell if " + "It is recommended to add the annotation to tell if " +

View File

@ -112,8 +112,8 @@ public class DefaultReceiveBufferSizePredictor implements
/** /**
* Creates a new predictor with the default parameters. With the default * Creates a new predictor with the default parameters. With the default
* parameters, the expected buffer size starts from {@code 1024}, doesn't * parameters, the expected buffer size starts from {@code 1024}, does not
* go down below {@code 64}, and doesn't go up above {@code 65536}. * go down below {@code 64}, and does not go up above {@code 65536}.
*/ */
public DefaultReceiveBufferSizePredictor() { public DefaultReceiveBufferSizePredictor() {
this(DEFAULT_MINIMUM, DEFAULT_INITIAL, DEFAULT_MAXIMUM); this(DEFAULT_MINIMUM, DEFAULT_INITIAL, DEFAULT_MAXIMUM);

View File

@ -287,7 +287,7 @@ class NioWorker implements Runnable {
} }
failure = false; failure = false;
} catch (AsynchronousCloseException e) { } catch (AsynchronousCloseException e) {
// Can happen, and doesn't need a user attention. // Can happen, and does not need a user attention.
} catch (Throwable t) { } catch (Throwable t) {
fireExceptionCaught(channel, t); fireExceptionCaught(channel, t);
} }
@ -334,7 +334,7 @@ class NioWorker implements Runnable {
} }
failure = false; failure = false;
} catch (AsynchronousCloseException e) { } catch (AsynchronousCloseException e) {
// Can happen, and doesn't need a user attention. // Can happen, and does not need a user attention.
} catch (Throwable t) { } catch (Throwable t) {
fireExceptionCaught(channel, t); fireExceptionCaught(channel, t);
} }

View File

@ -74,7 +74,7 @@ import org.jboss.netty.channel.socket.SocketChannel;
* *
* <h3>Limitation</h3> * <h3>Limitation</h3>
* <p> * <p>
* A {@link SocketChannel} created by this factory doesn't support asynchronous * A {@link SocketChannel} created by this factory does not support asynchronous
* operations. Any I/O requests such as {@code "connect"} and {@code "write"} * operations. Any I/O requests such as {@code "connect"} and {@code "write"}
* will be performed in a blocking manner. * will be performed in a blocking manner.
* *

View File

@ -87,7 +87,7 @@ import org.jboss.netty.channel.socket.ServerSocketChannelFactory;
* <h3>Limitation</h3> * <h3>Limitation</h3>
* <p> * <p>
* A {@link ServerSocketChannel} created by this factory and its child channels * A {@link ServerSocketChannel} created by this factory and its child channels
* don't support asynchronous operations. Any I/O requests such as * do not support asynchronous operations. Any I/O requests such as
* {@code "write"} will be performed in a blocking manner. * {@code "write"} will be performed in a blocking manner.
* *
* @author The Netty Project (netty-dev@lists.jboss.org) * @author The Netty Project (netty-dev@lists.jboss.org)

View File

@ -224,7 +224,7 @@ class OioServerSocketPipelineSink extends AbstractChannelSink {
} catch (SocketTimeoutException e) { } catch (SocketTimeoutException e) {
// Thrown every second to stop when requested. // Thrown every second to stop when requested.
} catch (IOException e) { } catch (IOException e) {
// Don't log the exception if the server socket was closed // Do not log the exception if the server socket was closed
// by a user. // by a user.
if (!channel.socket.isBound() || channel.socket.isClosed()) { if (!channel.socket.isBound() || channel.socket.isClosed()) {
break; break;

View File

@ -84,7 +84,7 @@ public class FactorialClient {
"Factorial of %,d is: %,d", count, handler.getFactorial()); "Factorial of %,d is: %,d", count, handler.getFactorial());
// We should shut down all thread pools here to exit normally. // We should shut down all thread pools here to exit normally.
// However, it's just fine to call System.exit(0) because we are // However, it is just fine to call System.exit(0) because we are
// finished with the business. // finished with the business.
System.exit(0); System.exit(0);
} }

View File

@ -102,7 +102,7 @@ public class SecureChatClient {
channel.close().awaitUninterruptibly(); channel.close().awaitUninterruptibly();
// We should shut down all thread pools here to exit normally. // We should shut down all thread pools here to exit normally.
// However, it's just fine to call System.exit(0) because we are // However, it is just fine to call System.exit(0) because we are
// finished with the business. // finished with the business.
System.exit(0); System.exit(0);
} }

View File

@ -103,7 +103,7 @@ public class SecureChatServerHandler extends SimpleChannelHandler {
public void channelDisconnected( public void channelDisconnected(
ChannelHandlerContext ctx, ChannelStateEvent e) throws Exception { ChannelHandlerContext ctx, ChannelStateEvent e) throws Exception {
// Unregister the channel from the global channel list // Unregister the channel from the global channel list
// so the channel doesn't receive messages anymore. // so the channel does not receive messages anymore.
channels.remove(e.getChannel()); channels.remove(e.getChannel());
} }

View File

@ -30,7 +30,7 @@ import javax.net.ssl.SSLContext;
/** /**
* Creates a bogus {@link SSLContext}. A client-side context created by this * Creates a bogus {@link SSLContext}. A client-side context created by this
* factory accepts any certificate even if it's invalid. A server-side context * factory accepts any certificate even if it is invalid. A server-side context
* created by this factory sends a bogus certificate defined in {@link SecureChatKeyStore}. * created by this factory sends a bogus certificate defined in {@link SecureChatKeyStore}.
* *
* You will have to create your context differently in a real world application. * You will have to create your context differently in a real world application.

View File

@ -35,7 +35,7 @@ import javax.net.ssl.X509TrustManager;
/** /**
* Bogus {@link TrustManagerFactorySpi} which accepts any certificate * Bogus {@link TrustManagerFactorySpi} which accepts any certificate
* even if it's invalid. * even if it is invalid.
* *
* @author The Netty Project (netty-dev@lists.jboss.org) * @author The Netty Project (netty-dev@lists.jboss.org)
* @author Trustin Lee (tlee@redhat.com) * @author Trustin Lee (tlee@redhat.com)
@ -51,13 +51,13 @@ public class SecureChatTrustManagerFactory extends TrustManagerFactorySpi {
public void checkClientTrusted( public void checkClientTrusted(
X509Certificate[] arg0, String arg1) throws CertificateException { X509Certificate[] arg0, String arg1) throws CertificateException {
// Always trust - it's an example. // Always trust - it is an example.
// You should do something in the real world. // You should do something in the real world.
} }
public void checkServerTrusted( public void checkServerTrusted(
X509Certificate[] arg0, String arg1) throws CertificateException { X509Certificate[] arg0, String arg1) throws CertificateException {
// Always trust - it's an example. // Always trust - it is an example.
// You should do something in the real world. // You should do something in the real world.
} }
}; };

View File

@ -102,7 +102,7 @@ public class TelnetClient {
channel.close().awaitUninterruptibly(); channel.close().awaitUninterruptibly();
// We should shut down all thread pools here to exit normally. // We should shut down all thread pools here to exit normally.
// However, it's just fine to call System.exit(0) because we are // However, it is just fine to call System.exit(0) because we are
// finished with the business. // finished with the business.
System.exit(0); System.exit(0);
} }

View File

@ -66,7 +66,7 @@ public class TelnetServerHandler extends SimpleChannelHandler {
// Send greeting for a new connection. // Send greeting for a new connection.
e.getChannel().write( e.getChannel().write(
"Welcome to " + InetAddress.getLocalHost().getHostName() + "!\n"); "Welcome to " + InetAddress.getLocalHost().getHostName() + "!\n");
e.getChannel().write("It's " + new Date() + " now.\n"); e.getChannel().write("It is " + new Date() + " now.\n");
} }
@Override @Override
@ -74,7 +74,7 @@ public class TelnetServerHandler extends SimpleChannelHandler {
ChannelHandlerContext ctx, MessageEvent e) { ChannelHandlerContext ctx, MessageEvent e) {
// Cast to a String first. // Cast to a String first.
// We know it's a String because we put some codec in TelnetPipelineFactory. // We know it is a String because we put some codec in TelnetPipelineFactory.
String request = (String) e.getMessage(); String request = (String) e.getMessage();
// Generate and write a response. // Generate and write a response.
@ -89,7 +89,7 @@ public class TelnetServerHandler extends SimpleChannelHandler {
response = "Did you say '" + request + "'?\n"; response = "Did you say '" + request + "'?\n";
} }
// We don't need to write a ChannelBuffer here. // We do not need to write a ChannelBuffer here.
// We know the encoder inserted at TelnetPipelineFactory will do the conversion. // We know the encoder inserted at TelnetPipelineFactory will do the conversion.
ChannelFuture future = e.getChannel().write(response); ChannelFuture future = e.getChannel().write(response);

View File

@ -42,7 +42,7 @@ import org.jboss.netty.channel.SimpleChannelHandler;
* <p> * <p>
* In a stream-based transport such as TCP/IP, packets can be fragmented and * In a stream-based transport such as TCP/IP, packets can be fragmented and
* reassembled during transmission even in a LAN environment. For example, * reassembled during transmission even in a LAN environment. For example,
* let's assume you have received three packets: * let us assume you have received three packets:
* <pre> * <pre>
* +-----+-----+-----+ * +-----+-----+-----+
* | ABC | DEF | GHI | * | ABC | DEF | GHI |
@ -233,11 +233,11 @@ public abstract class FrameDecoder extends SimpleChannelHandler {
if (frame == null) { if (frame == null) {
if (oldReaderIndex == cumulation.readerIndex()) { if (oldReaderIndex == cumulation.readerIndex()) {
// Seems like more data is required. // Seems like more data is required.
// Let's wait for the next notification. // Let us wait for the next notification.
break; break;
} else { } else {
// Previous data has been discarded. // Previous data has been discarded.
// Probably it's reading on. // Probably it is reading on.
continue; continue;
} }
} else if (oldReaderIndex == cumulation.readerIndex()) { } else if (oldReaderIndex == cumulation.readerIndex()) {

View File

@ -300,7 +300,7 @@ public abstract class ReplayingDecoder<T extends Enum<T>> extends SimpleChannelH
"null cannot be returned if no data is consumed."); "null cannot be returned if no data is consumed.");
} else { } else {
// Previous data has been discarded. // Previous data has been discarded.
// Probably it's reading on. // Probably it is reading on.
continue; continue;
} }
} }
@ -311,7 +311,7 @@ public abstract class ReplayingDecoder<T extends Enum<T>> extends SimpleChannelH
if (result == null) { if (result == null) {
// Seems like more data is required. // Seems like more data is required.
// Let's wait for the next notification. // Let us wait for the next notification.
break; break;
} }

View File

@ -45,6 +45,6 @@ class UnsafeDynamicChannelBuffer extends DynamicChannelBuffer {
@Override @Override
protected void checkReadableBytes(int minReaderRemaining) { protected void checkReadableBytes(int minReaderRemaining) {
// Don't check here - ReplayingDecoderBuffer will check. // Do not check here - ReplayingDecoderBuffer will check.
} }
} }

View File

@ -42,7 +42,7 @@ import org.jboss.netty.util.SwitchableInputStream;
* streams such as {@link ObjectInputStream} and {@link ObjectOutputStream}. * streams such as {@link ObjectInputStream} and {@link ObjectOutputStream}.
* <p> * <p>
* However, this decoder might perform worse than {@link ObjectDecoder} if * However, this decoder might perform worse than {@link ObjectDecoder} if
* the serialized object is big and complex. Also, it doesn't limit the * the serialized object is big and complex. Also, it does not limit the
* maximum size of the object, and consequently your application might face * maximum size of the object, and consequently your application might face
* the risk of <a href="http://en.wikipedia.org/wiki/DoS">DoS attack</a>. * the risk of <a href="http://en.wikipedia.org/wiki/DoS">DoS attack</a>.
* Please use {@link ObjectEncoder} and {@link ObjectDecoder} if you are not * Please use {@link ObjectEncoder} and {@link ObjectDecoder} if you are not

View File

@ -29,7 +29,7 @@ import org.jboss.netty.channel.ChannelHandlerContext;
/** /**
* a {@link Runnable} which sends the specified {@link ChannelEvent} upstream. * a {@link Runnable} which sends the specified {@link ChannelEvent} upstream.
* Most users will not see this type at all because it's used by * Most users will not see this type at all because it is used by
* {@link Executor} implementors only * {@link Executor} implementors only
* *
* @author The Netty Project (netty-dev@lists.jboss.org) * @author The Netty Project (netty-dev@lists.jboss.org)

View File

@ -175,7 +175,7 @@ public class MemoryAwareThreadPoolExecutor extends ThreadPoolExecutor {
this.objectSizeEstimator = objectSizeEstimator; this.objectSizeEstimator = objectSizeEstimator;
// Call allowCoreThreadTimeOut(true) using reflection // Call allowCoreThreadTimeOut(true) using reflection
// because it's not supported in Java 5. // because it is not supported in Java 5.
try { try {
Method m = getClass().getMethod("allowCoreThreadTimeOut", new Class[] { boolean.class }); Method m = getClass().getMethod("allowCoreThreadTimeOut", new Class[] { boolean.class });
m.invoke(this, Boolean.TRUE); m.invoke(this, Boolean.TRUE);

View File

@ -60,7 +60,7 @@ import org.jboss.netty.util.ImmediateExecutor;
* <h3>Beginning the handshake</h3> * <h3>Beginning the handshake</h3>
* <p> * <p>
* A user should make sure not to write a message while the * A user should make sure not to write a message while the
* {@linkplain #handshake(Channel) handshake} is in progress unless it's a * {@linkplain #handshake(Channel) handshake} is in progress unless it is a
* renegotiation. You will be notified by the {@link ChannelFuture} which is * renegotiation. You will be notified by the {@link ChannelFuture} which is
* returned by the {@link #handshake(Channel)} method when the handshake * returned by the {@link #handshake(Channel)} method when the handshake
* process succeeds or fails. * process succeeds or fails.
@ -77,7 +77,7 @@ import org.jboss.netty.util.ImmediateExecutor;
* exception is when you close the {@link Channel} - {@link SslHandler} * exception is when you close the {@link Channel} - {@link SslHandler}
* intercepts the close request and send the {@code close_notify} message * intercepts the close request and send the {@code close_notify} message
* before the channel closure automatically. Once the SSL session is closed, * before the channel closure automatically. Once the SSL session is closed,
* it's not reusable, and consequently you should create a new * it is not reusable, and consequently you should create a new
* {@link SslHandler} with a new {@link SSLEngine} as explained in the * {@link SslHandler} with a new {@link SSLEngine} as explained in the
* following section. * following section.
* *
@ -319,7 +319,7 @@ public class SslHandler extends FrameDecoder {
return; return;
} }
// Don't encrypt the first write request if this handler is // Do not encrypt the first write request if this handler is
// created with startTLS flag turned on. // created with startTLS flag turned on.
if (startTls && sentFirstMessage.compareAndSet(false, true)) { if (startTls && sentFirstMessage.compareAndSet(false, true)) {
context.sendDownstream(evt); context.sendDownstream(evt);
@ -498,7 +498,7 @@ public class SslHandler extends FrameDecoder {
if (!success) { if (!success) {
// Mark all remaining pending writes as failure if anything // Mark all remaining pending writes as failure if anything
// wrong happened before the write requests are wrapped. // wrong happened before the write requests are wrapped.
// Please note that we don't call setFailure while a lock is // Please note that we do not call setFailure while a lock is
// acquired, to avoid a potential dead lock. // acquired, to avoid a potential dead lock.
for (;;) { for (;;) {
PendingWrite pendingWrite; PendingWrite pendingWrite;

View File

@ -82,7 +82,7 @@ public class LinkedTransferQueue<E> extends AbstractQueue<E> implements Blocking
* *
* The main extension is to provide different Wait modes * The main extension is to provide different Wait modes
* for the main "xfer" method that puts or takes items. * for the main "xfer" method that puts or takes items.
* These don't impact the basic dual-queue logic, but instead * These do not impact the basic dual-queue logic, but instead
* control whether or how threads block upon insertion * control whether or how threads block upon insertion
* of request or data nodes into the dual queue. * of request or data nodes into the dual queue.
*/ */
@ -109,7 +109,7 @@ public class LinkedTransferQueue<E> extends AbstractQueue<E> implements Blocking
/** /**
* The number of times to spin before blocking in untimed waits. * The number of times to spin before blocking in untimed waits.
* This is greater than timed value because untimed waits spin * This is greater than timed value because untimed waits spin
* faster since they don't need to check times on each spin. * faster since they do not need to check times on each spin.
*/ */
private static final int maxUntimedSpins = maxTimedSpins * 16; private static final int maxUntimedSpins = maxTimedSpins * 16;

View File

@ -84,7 +84,7 @@ public class MapUtil {
if (logger.isDebugEnabled()) { if (logger.isDebugEnabled()) {
logger.debug( logger.debug(
mapType.getName() + mapType.getName() +
" doesn't implement OrderedMap interface."); " does not implement OrderedMap interface.");
} }
// Last resort: try to create a new instance and test if it maintains // Last resort: try to create a new instance and test if it maintains

View File

@ -68,7 +68,7 @@ public class StackTraceSimplifier {
return; return;
} }
// Perhaps Netty bug. Let's not strip things out. // Perhaps Netty bug. Let us not strip things out.
if (EXCLUDED_STACK_TRACE.matcher(trace[0].getClassName()).matches()) { if (EXCLUDED_STACK_TRACE.matcher(trace[0].getClassName()).matches()) {
return; return;
} }

View File

@ -79,7 +79,7 @@ public class ThreadRenamingRunnable implements Runnable {
} finally { } finally {
if (renamed) { if (renamed) {
// Revert the name back if the current thread was renamed. // Revert the name back if the current thread was renamed.
// We don't check the exception here because we know it works. // We do not check the exception here because we know it works.
currentThread.setName(oldThreadName); currentThread.setName(oldThreadName);
} }
} }

View File

@ -132,7 +132,7 @@ public abstract class AbstractSocketServerBootstrapTest {
} }
// Wait until the child connection is closed in the client side. // Wait until the child connection is closed in the client side.
// We don't use Channel.close() to make sure it's closed automatically. // We do not use Channel.close() to make sure it is closed automatically.
while (pch.child.isOpen()) { while (pch.child.isOpen()) {
try { try {
Thread.sleep(1); Thread.sleep(1);

View File

@ -1194,7 +1194,7 @@ public abstract class AbstractChannelBufferTest {
ChannelBuffer actualValue = buffer.readBytes(BLOCK_SIZE); ChannelBuffer actualValue = buffer.readBytes(BLOCK_SIZE);
assertEquals(wrappedBuffer(expectedValue), actualValue); assertEquals(wrappedBuffer(expectedValue), actualValue);
// Make sure if it's a copied buffer. // Make sure if it is a copied buffer.
actualValue.setByte(0, (byte) (actualValue.getByte(0) + 1)); actualValue.setByte(0, (byte) (actualValue.getByte(0) + 1));
assertFalse(buffer.getByte(i) == actualValue.getByte(0)); assertFalse(buffer.getByte(i) == actualValue.getByte(0));
} }
@ -1219,7 +1219,7 @@ public abstract class AbstractChannelBufferTest {
ChannelBuffer copy = buffer.readBytes(ChannelBufferIndexFinder.NUL); ChannelBuffer copy = buffer.readBytes(ChannelBufferIndexFinder.NUL);
assertEquals(wrappedBuffer(new byte[] { 1, 2, 3, 4 }), copy); assertEquals(wrappedBuffer(new byte[] { 1, 2, 3, 4 }), copy);
// Make sure if it's a copied buffer. // Make sure if it is a copied buffer.
copy.setByte(0, (byte) (copy.getByte(0) + 1)); copy.setByte(0, (byte) (copy.getByte(0) + 1));
assertFalse(buffer.getByte(0) == copy.getByte(0)); assertFalse(buffer.getByte(0) == copy.getByte(0));
} }
@ -1244,7 +1244,7 @@ public abstract class AbstractChannelBufferTest {
ChannelBuffer actualValue = buffer.readSlice(BLOCK_SIZE); ChannelBuffer actualValue = buffer.readSlice(BLOCK_SIZE);
assertEquals(wrappedBuffer(expectedValue), actualValue); assertEquals(wrappedBuffer(expectedValue), actualValue);
// Make sure if it's a sliced buffer. // Make sure if it is a sliced buffer.
actualValue.setByte(0, (byte) (actualValue.getByte(0) + 1)); actualValue.setByte(0, (byte) (actualValue.getByte(0) + 1));
assertEquals(buffer.getByte(i), actualValue.getByte(0)); assertEquals(buffer.getByte(i), actualValue.getByte(0));
} }
@ -1269,7 +1269,7 @@ public abstract class AbstractChannelBufferTest {
ChannelBuffer slice = buffer.readSlice(ChannelBufferIndexFinder.NUL); ChannelBuffer slice = buffer.readSlice(ChannelBufferIndexFinder.NUL);
assertEquals(wrappedBuffer(new byte[] { 1, 2, 3, 4 }), slice); assertEquals(wrappedBuffer(new byte[] { 1, 2, 3, 4 }), slice);
// Make sure if it's a sliced buffer. // Make sure if it is a sliced buffer.
slice.setByte(0, (byte) (slice.getByte(0) + 1)); slice.setByte(0, (byte) (slice.getByte(0) + 1));
assertTrue(buffer.getByte(0) == slice.getByte(0)); assertTrue(buffer.getByte(0) == slice.getByte(0));
} }