From ada07cb9e0700dff4ecdc3d20afc46ea46f1bc38 Mon Sep 17 00:00:00 2001 From: kerr Date: Mon, 22 Jul 2013 19:51:09 +0800 Subject: [PATCH] Fix types in javadocs --- .../main/java/io/netty/buffer/AbstractByteBufAllocator.java | 2 +- buffer/src/main/java/io/netty/buffer/ByteBuf.java | 2 +- buffer/src/main/java/io/netty/buffer/Unpooled.java | 2 +- common/src/main/java/io/netty/util/concurrent/Future.java | 2 +- .../util/concurrent/MultithreadEventExecutorGroup.java | 2 +- .../io/netty/util/concurrent/SingleThreadEventExecutor.java | 2 +- .../src/main/java/io/netty/channel/AbstractChannel.java | 2 +- transport/src/main/java/io/netty/channel/ChannelConfig.java | 6 +++--- .../java/io/netty/channel/ChannelFlushPromiseNotifier.java | 6 +++--- .../main/java/io/netty/channel/ChannelHandlerContext.java | 4 ++-- .../src/main/java/io/netty/channel/ChannelInitializer.java | 2 +- .../main/java/io/netty/channel/ChannelOutboundInvoker.java | 4 ++-- .../src/main/java/io/netty/channel/ChannelPipeline.java | 2 +- .../src/main/java/io/netty/channel/EventLoopException.java | 2 +- .../java/io/netty/channel/SimpleChannelInboundHandler.java | 2 +- .../java/io/netty/channel/oio/AbstractOioByteChannel.java | 6 +++--- 16 files changed, 24 insertions(+), 24 deletions(-) diff --git a/buffer/src/main/java/io/netty/buffer/AbstractByteBufAllocator.java b/buffer/src/main/java/io/netty/buffer/AbstractByteBufAllocator.java index 60be062d0e..7b6df90aa3 100644 --- a/buffer/src/main/java/io/netty/buffer/AbstractByteBufAllocator.java +++ b/buffer/src/main/java/io/netty/buffer/AbstractByteBufAllocator.java @@ -19,7 +19,7 @@ package io.netty.buffer; import io.netty.util.internal.PlatformDependent; /** - * Skeltal {@link ByteBufAllocator} implementation to extend. + * Skeletal {@link ByteBufAllocator} implementation to extend. */ public abstract class AbstractByteBufAllocator implements ByteBufAllocator { private static final int DEFAULT_INITIAL_CAPACITY = 256; diff --git a/buffer/src/main/java/io/netty/buffer/ByteBuf.java b/buffer/src/main/java/io/netty/buffer/ByteBuf.java index 48a0362425..be93120efc 100644 --- a/buffer/src/main/java/io/netty/buffer/ByteBuf.java +++ b/buffer/src/main/java/io/netty/buffer/ByteBuf.java @@ -1687,7 +1687,7 @@ public abstract class ByteBuf implements ReferenceCounted, Comparable { * or {@link #nioBuffers(int, int)} might return a less number of {@link ByteBuffer}s. * * @return {@code -1} if this buffer has no underlying {@link ByteBuffer}. - * the number of the underlying {@link ByteBuffer}s if this buffer has at least one undelying + * the number of the underlying {@link ByteBuffer}s if this buffer has at least one underlying * {@link ByteBuffer}. Note that this method does not return {@code 0} to avoid confusion. * * @see #nioBuffer() diff --git a/buffer/src/main/java/io/netty/buffer/Unpooled.java b/buffer/src/main/java/io/netty/buffer/Unpooled.java index 5fce44772e..2a16be9149 100644 --- a/buffer/src/main/java/io/netty/buffer/Unpooled.java +++ b/buffer/src/main/java/io/netty/buffer/Unpooled.java @@ -102,7 +102,7 @@ public final class Unpooled { } /** - * Creates a new big-endian direct buffer with resaonably small initial capacity, which + * Creates a new big-endian direct buffer with reasonably small initial capacity, which * expands its capacity boundlessly on demand. */ public static ByteBuf directBuffer() { diff --git a/common/src/main/java/io/netty/util/concurrent/Future.java b/common/src/main/java/io/netty/util/concurrent/Future.java index f3cf6878f3..8ddb860e14 100644 --- a/common/src/main/java/io/netty/util/concurrent/Future.java +++ b/common/src/main/java/io/netty/util/concurrent/Future.java @@ -162,7 +162,7 @@ public interface Future extends java.util.concurrent.Future { /** * {@inheritDoc} * - * If the cancelation was successful it will fail the future with an {@link CancellationException}. + * If the cancellation was successful it will fail the future with an {@link CancellationException}. */ @Override boolean cancel(boolean mayInterruptIfRunning); diff --git a/common/src/main/java/io/netty/util/concurrent/MultithreadEventExecutorGroup.java b/common/src/main/java/io/netty/util/concurrent/MultithreadEventExecutorGroup.java index 2542e65340..38efd4912e 100644 --- a/common/src/main/java/io/netty/util/concurrent/MultithreadEventExecutorGroup.java +++ b/common/src/main/java/io/netty/util/concurrent/MultithreadEventExecutorGroup.java @@ -126,7 +126,7 @@ public abstract class MultithreadEventExecutorGroup extends AbstractEventExecuto } /** - * Create a new EventExecutor which will later then accessable via the {@link #next()} method. This method will be + * Create a new EventExecutor which will later then accessible via the {@link #next()} method. This method will be * called for each thread that will serve this {@link MultithreadEventExecutorGroup}. * */ diff --git a/common/src/main/java/io/netty/util/concurrent/SingleThreadEventExecutor.java b/common/src/main/java/io/netty/util/concurrent/SingleThreadEventExecutor.java index c6a1893aa9..a4027c91b2 100644 --- a/common/src/main/java/io/netty/util/concurrent/SingleThreadEventExecutor.java +++ b/common/src/main/java/io/netty/util/concurrent/SingleThreadEventExecutor.java @@ -379,7 +379,7 @@ public abstract class SingleThreadEventExecutor extends AbstractEventExecutor { } /** - * Returns the ammount of time left until the scheduled task with the closest dead line is executed. + * Returns the amount of time left until the scheduled task with the closest dead line is executed. */ protected long delayNanos(long currentTimeNanos) { ScheduledFutureTask delayedTask = delayedTaskQueue.peek(); diff --git a/transport/src/main/java/io/netty/channel/AbstractChannel.java b/transport/src/main/java/io/netty/channel/AbstractChannel.java index 39b09f11e3..74fb5aa599 100644 --- a/transport/src/main/java/io/netty/channel/AbstractChannel.java +++ b/transport/src/main/java/io/netty/channel/AbstractChannel.java @@ -615,7 +615,7 @@ public abstract class AbstractChannel extends DefaultAttributeMap implements Cha @Override public void write(Object msg, ChannelPromise promise) { if (!isActive()) { - // Mark the write request as failure if the channl is inactive. + // Mark the write request as failure if the channel is inactive. if (isOpen()) { promise.tryFailure(NOT_YET_CONNECTED_EXCEPTION); } else { diff --git a/transport/src/main/java/io/netty/channel/ChannelConfig.java b/transport/src/main/java/io/netty/channel/ChannelConfig.java index 1fa67bea43..f15b9cff50 100644 --- a/transport/src/main/java/io/netty/channel/ChannelConfig.java +++ b/transport/src/main/java/io/netty/channel/ChannelConfig.java @@ -121,13 +121,13 @@ public interface ChannelConfig { /** * Returns the maximum number of messages to read per read loop. * a {@link ChannelInboundHandler#channelRead(ChannelHandlerContext, Object) channelRead()} event. - * If this value is greater than 1, an event loop might attempt to read multiple times to procude multiple messages. + * If this value is greater than 1, an event loop might attempt to read multiple times to procure multiple messages. */ int getMaxMessagesPerRead(); /** * Sets the maximum number of messages to read per read loop. - * If this value is greater than 1, an event loop might attempt to read multiple times toprocude multiple messages. + * If this value is greater than 1, an event loop might attempt to read multiple times to procure multiple messages. */ ChannelConfig setMaxMessagesPerRead(int maxMessagesPerRead); @@ -215,7 +215,7 @@ public interface ChannelConfig { * Sets the low water mark of the write buffer. Once the number of bytes * queued in the write buffer exceeded the * {@linkplain #setWriteBufferHighWaterMark(int) high water mark} and then - * dropped down below this value, {@link Channel#isWritable()} will start toreturn + * dropped down below this value, {@link Channel#isWritable()} will start to return * {@code true} again. */ ChannelConfig setWriteBufferLowWaterMark(int writeBufferLowWaterMark); diff --git a/transport/src/main/java/io/netty/channel/ChannelFlushPromiseNotifier.java b/transport/src/main/java/io/netty/channel/ChannelFlushPromiseNotifier.java index 84ca4a5c52..949806d48e 100644 --- a/transport/src/main/java/io/netty/channel/ChannelFlushPromiseNotifier.java +++ b/transport/src/main/java/io/netty/channel/ChannelFlushPromiseNotifier.java @@ -93,7 +93,7 @@ public final class ChannelFlushPromiseNotifier { * their pendingDatasize is smaller after the the current writeCounter returned by {@link #writeCounter()}. * * After a {@link ChannelFuture} was notified it will be removed from this {@link ChannelFlushPromiseNotifier} and - * so not receive anymore notificiation. + * so not receive anymore notification. */ public ChannelFlushPromiseNotifier notifyFlushFutures() { notifyFlushFutures0(null); @@ -105,7 +105,7 @@ public final class ChannelFlushPromiseNotifier { * their pendingDatasize isis smaller then the current writeCounter returned by {@link #writeCounter()}. * * After a {@link ChannelFuture} was notified it will be removed from this {@link ChannelFlushPromiseNotifier} and - * so not receive anymore notificiation. + * so not receive anymore notification. * * The rest of the remaining {@link ChannelFuture}s will be failed with the given {@link Throwable}. * @@ -133,7 +133,7 @@ public final class ChannelFlushPromiseNotifier { * the given cause1. * * After a {@link ChannelFuture} was notified it will be removed from this {@link ChannelFlushPromiseNotifier} and - * so not receive anymore notificiation. + * so not receive anymore notification. * * The rest of the remaining {@link ChannelFuture}s will be failed with the given {@link Throwable}. * diff --git a/transport/src/main/java/io/netty/channel/ChannelHandlerContext.java b/transport/src/main/java/io/netty/channel/ChannelHandlerContext.java index 57b9881c37..995d223fd5 100644 --- a/transport/src/main/java/io/netty/channel/ChannelHandlerContext.java +++ b/transport/src/main/java/io/netty/channel/ChannelHandlerContext.java @@ -133,8 +133,8 @@ public interface ChannelHandlerContext /** * The {@link EventExecutor} that is used to dispatch the events. This can also be used to directly - * submit tasks that get executed in the event loop. For more informations please refer to the - * {@link EventExecutor} javadocs. + * submit tasks that get executed in the event loop. For more information please refer to the + * {@link EventExecutor} javadoc. */ EventExecutor executor(); diff --git a/transport/src/main/java/io/netty/channel/ChannelInitializer.java b/transport/src/main/java/io/netty/channel/ChannelInitializer.java index d03cc2e585..043458b554 100644 --- a/transport/src/main/java/io/netty/channel/ChannelInitializer.java +++ b/transport/src/main/java/io/netty/channel/ChannelInitializer.java @@ -56,7 +56,7 @@ public abstract class ChannelInitializer extends ChannelInbou * will be removed from the {@link ChannelPipeline} of the {@link Channel}. * * @param ch the {@link Channel} which was registered. - * @throws Exception is thrown if an error occours. In that case the {@link Channel} will be closed. + * @throws Exception is thrown if an error occurs. In that case the {@link Channel} will be closed. */ protected abstract void initChannel(C ch) throws Exception; diff --git a/transport/src/main/java/io/netty/channel/ChannelOutboundInvoker.java b/transport/src/main/java/io/netty/channel/ChannelOutboundInvoker.java index 7124627200..3b6a326344 100644 --- a/transport/src/main/java/io/netty/channel/ChannelOutboundInvoker.java +++ b/transport/src/main/java/io/netty/channel/ChannelOutboundInvoker.java @@ -64,7 +64,7 @@ interface ChannelOutboundInvoker { ChannelFuture connect(SocketAddress remoteAddress, SocketAddress localAddress); /** - * Request to discconect from the remote peer and notify the {@link ChannelFuture} once the operation completes, + * Request to disconnect from the remote peer and notify the {@link ChannelFuture} once the operation completes, * either because the operation was successful or because of an error. *

* This will result in having the @@ -146,7 +146,7 @@ interface ChannelOutboundInvoker { ChannelFuture connect(SocketAddress remoteAddress, SocketAddress localAddress, ChannelPromise promise); /** - * Request to discconect from the remote peer and notify the {@link ChannelFuture} once the operation completes, + * Request to disconnect from the remote peer and notify the {@link ChannelFuture} once the operation completes, * either because the operation was successful or because of an error. * * The given {@link ChannelPromise} will be notified. diff --git a/transport/src/main/java/io/netty/channel/ChannelPipeline.java b/transport/src/main/java/io/netty/channel/ChannelPipeline.java index bf05829df1..c7a86fa0d4 100644 --- a/transport/src/main/java/io/netty/channel/ChannelPipeline.java +++ b/transport/src/main/java/io/netty/channel/ChannelPipeline.java @@ -29,7 +29,7 @@ import java.util.NoSuchElementException; /** - * A list of {@link ChannelHandler}s which handles or intercepts inbound events and outbount operations of a + * A list of {@link ChannelHandler}s which handles or intercepts inbound events and outbound operations of a * {@link Channel}. {@link ChannelPipeline} implements an advanced form of the * Intercepting Filter pattern * to give a user full control over how an event is handled and how the {@link ChannelHandler}s in a pipeline diff --git a/transport/src/main/java/io/netty/channel/EventLoopException.java b/transport/src/main/java/io/netty/channel/EventLoopException.java index 0eb9bdd9d3..57009fbe3e 100644 --- a/transport/src/main/java/io/netty/channel/EventLoopException.java +++ b/transport/src/main/java/io/netty/channel/EventLoopException.java @@ -17,7 +17,7 @@ package io.netty.channel; /** * Special {@link ChannelException} which will be thrown by {@link EventLoop} and {@link EventLoopGroup} - * implementations when an error accours. + * implementations when an error occurs. */ public class EventLoopException extends ChannelException { diff --git a/transport/src/main/java/io/netty/channel/SimpleChannelInboundHandler.java b/transport/src/main/java/io/netty/channel/SimpleChannelInboundHandler.java index 5b8df6e852..21acac72af 100644 --- a/transport/src/main/java/io/netty/channel/SimpleChannelInboundHandler.java +++ b/transport/src/main/java/io/netty/channel/SimpleChannelInboundHandler.java @@ -113,7 +113,7 @@ public abstract class SimpleChannelInboundHandler extends ChannelInboundHandl * @param ctx the {@link ChannelHandlerContext} which this {@link SimpleChannelInboundHandler} * belongs to * @param msg the message to handle - * @throws Exception is thrown if an error accour + * @throws Exception is thrown if an error occurred */ protected abstract void channelRead0(ChannelHandlerContext ctx, I msg) throws Exception; } diff --git a/transport/src/main/java/io/netty/channel/oio/AbstractOioByteChannel.java b/transport/src/main/java/io/netty/channel/oio/AbstractOioByteChannel.java index cc682c1ff7..714cfeb3b6 100644 --- a/transport/src/main/java/io/netty/channel/oio/AbstractOioByteChannel.java +++ b/transport/src/main/java/io/netty/channel/oio/AbstractOioByteChannel.java @@ -187,7 +187,7 @@ public abstract class AbstractOioByteChannel extends AbstractOioChannel { * @param buf the {@link ByteBuf} into which the read bytes will be written * @return amount the number of bytes read. This may return a negative amount if the underlying * Socket was closed - * @throws Exception is thrown if an error accoured + * @throws Exception is thrown if an error occurred */ protected abstract int doReadBytes(ByteBuf buf) throws Exception; @@ -195,7 +195,7 @@ public abstract class AbstractOioByteChannel extends AbstractOioChannel { * Write the data which is hold by the {@link ByteBuf} to the underlying Socket. * * @param buf the {@link ByteBuf} which holds the data to transfer - * @throws Exception is thrown if an error accoured + * @throws Exception is thrown if an error occurred */ protected abstract void doWriteBytes(ByteBuf buf) throws Exception; @@ -203,7 +203,7 @@ public abstract class AbstractOioByteChannel extends AbstractOioChannel { * Write the data which is hold by the {@link FileRegion} to the underlying Socket. * * @param region the {@link FileRegion} which holds the data to transfer - * @throws Exception is thrown if an error accoured + * @throws Exception is thrown if an error occurred */ protected abstract void doWriteFileRegion(FileRegion region) throws Exception; }