Created placeholder documentation to document relationship between input classes

This commit is contained in:
Collin Smith 2020-08-08 14:26:25 -07:00
parent 83ead2a990
commit 683d592c55
2 changed files with 20 additions and 0 deletions

View File

@ -2,6 +2,16 @@ package com.riiablo.io.nio;
import org.apache.commons.lang3.StringUtils;
/**
* Wraps a {@link ByteInput} to support reading sequences of bits and
* supporting {@link #align() re-aligning} the byte stream to read sequences of
* {@link ByteInput bytes}. All read functions will return results in little
* endian byte order.
*
* @see BitInput
* @see #align()
*/
// TODO: improve placeholder documentation
public class BitInput {
public static BitInput wrap(byte[] bytes) {
return ByteInput.wrap(bytes).unalign();

View File

@ -7,6 +7,16 @@ import java.nio.charset.Charset;
import com.riiablo.util.DebugUtils;
/**
* Wraps a {@link ByteBuf} to support reading sequences of bytes and supporting
* {@link #unalign() unaligning} the byte stream to read sequences of
* {@link BitInput bits}. All read functions will return results in little
* endian byte order.
*
* @see BitInput
* @see #unalign()
*/
// TODO: improve placeholder documentation
public class ByteInput {
private static final ByteInput EMPTY_BYTEINPUT = new ByteInput(Unpooled.EMPTY_BUFFER);
public static ByteInput emptyByteInput() {