diff --git a/buffer/src/main/java/io/netty/buffer/AbstractWrappedByteBuf.java b/buffer/src/main/java/io/netty/buffer/AbstractWrappedByteBuf.java index de314e66cf..e40c1d14f0 100644 --- a/buffer/src/main/java/io/netty/buffer/AbstractWrappedByteBuf.java +++ b/buffer/src/main/java/io/netty/buffer/AbstractWrappedByteBuf.java @@ -21,6 +21,9 @@ import java.nio.ByteBuffer; import java.nio.ByteOrder; import java.nio.ReadOnlyBufferException; +/** + * Abstract base class for WrappedByteBuf implementations. + */ public abstract class AbstractWrappedByteBuf extends AbstractByteBuf implements WrappedByteBuf { protected AbstractWrappedByteBuf(ByteOrder endianness, int maxCapacity) { diff --git a/buffer/src/main/java/io/netty/buffer/ChannelBuf.java b/buffer/src/main/java/io/netty/buffer/ChannelBuf.java index 576afe17ec..82627cd804 100644 --- a/buffer/src/main/java/io/netty/buffer/ChannelBuf.java +++ b/buffer/src/main/java/io/netty/buffer/ChannelBuf.java @@ -16,6 +16,14 @@ package io.netty.buffer; public interface ChannelBuf { + /** + * The ChannelBufType which will be handled by the ChannelBuf implementation + */ ChannelBufType type(); + + /** + * Return true if the ChannelBuf is pooled. + * + */ boolean isPooled(); } diff --git a/buffer/src/main/java/io/netty/buffer/ChannelBufType.java b/buffer/src/main/java/io/netty/buffer/ChannelBufType.java index 86a5b764e7..d14126af79 100644 --- a/buffer/src/main/java/io/netty/buffer/ChannelBufType.java +++ b/buffer/src/main/java/io/netty/buffer/ChannelBufType.java @@ -15,7 +15,17 @@ */ package io.netty.buffer; +/** + * The type of the ChannelBuf + */ public enum ChannelBufType { + /** + * Operates one bytes. + */ BYTE, + + /** + * Operates on messages, which can be of any kind. + */ MESSAGE } diff --git a/buffer/src/main/java/io/netty/buffer/MessageBuf.java b/buffer/src/main/java/io/netty/buffer/MessageBuf.java index 1c55fc0f74..de6c621c88 100644 --- a/buffer/src/main/java/io/netty/buffer/MessageBuf.java +++ b/buffer/src/main/java/io/netty/buffer/MessageBuf.java @@ -18,6 +18,11 @@ package io.netty.buffer; import java.util.Collection; import java.util.Queue; +/** + * ChannelBuf which operates on messages + * + * @param + */ public interface MessageBuf extends ChannelBuf, Queue { int drainTo(Collection c); int drainTo(Collection c, int maxElements);