Class AbstractIoBuffer

java.lang.Object
com.google.code.yanf4j.buffer.IoBuffer
com.google.code.yanf4j.buffer.AbstractIoBuffer
All Implemented Interfaces:
Comparable<IoBuffer>
Direct Known Subclasses:
CachedBufferAllocator.CachedBuffer, SimpleBufferAllocator.SimpleBuffer

public abstract class AbstractIoBuffer extends IoBuffer
A base implementation of IoBuffer. This implementation assumes that IoBuffer.buf() always returns a correct NIO ByteBuffer instance. Most implementations could extend this class and implement their own buffer management mechanism.
Version:
$Rev: 748210 $, $Date: 2009-02-26 18:05:40 +0100 (Thu, 26 Feb 2009) $
See Also:
  • Field Details

    • derived

      private final boolean derived
      Tells if a buffer has been created from an existing buffer
    • autoExpand

      private boolean autoExpand
      A flag set to true if the buffer can extend automatically
    • autoShrink

      private boolean autoShrink
      A flag set to true if the buffer can shrink automatically
    • recapacityAllowed

      private boolean recapacityAllowed
      Tells if a buffer can be expanded
    • minimumCapacity

      private int minimumCapacity
      The minimum number of bytes the IoBuffer can hold
    • BYTE_MASK

      private static final long BYTE_MASK
      A mask for a byte
      See Also:
    • SHORT_MASK

      private static final long SHORT_MASK
      A mask for a short
      See Also:
    • INT_MASK

      private static final long INT_MASK
      A mask for an int
      See Also:
    • mark

      private int mark
      We don't have any access to Buffer.markValue(), so we need to track it down, which will cause small extra overhead.
  • Constructor Details

    • AbstractIoBuffer

      protected AbstractIoBuffer(IoBufferAllocator allocator, int initialCapacity)
      Creates a new parent buffer.
      Parameters:
      allocator - The allocator to use to create new buffers
      initialCapacity - The initial buffer capacity when created
    • AbstractIoBuffer

      protected AbstractIoBuffer(AbstractIoBuffer parent)
      Creates a new derived buffer. A derived buffer uses an existing buffer properties - the allocator and capacity -.
      Parameters:
      parent - The buffer we get the properties from
  • Method Details

    • isDirect

      public final boolean isDirect()
      Specified by:
      isDirect in class IoBuffer
      See Also:
    • isReadOnly

      public final boolean isReadOnly()
      Specified by:
      isReadOnly in class IoBuffer
      See Also:
    • buf

      protected abstract void buf(ByteBuffer newBuf)
      Sets the underlying NIO buffer instance.
      Parameters:
      newBuf - The buffer to store within this IoBuffer
    • minimumCapacity

      public final int minimumCapacity()
      Returns the minimum capacity of this buffer which is used to determine the new capacity of the buffer shrunk by IoBuffer.compact() and IoBuffer.shrink() operation. The default value is the initial capacity of the buffer.
      Specified by:
      minimumCapacity in class IoBuffer
    • minimumCapacity

      public final IoBuffer minimumCapacity(int minimumCapacity)
      Sets the minimum capacity of this buffer which is used to determine the new capacity of the buffer shrunk by IoBuffer.compact() and IoBuffer.shrink() operation. The default value is the initial capacity of the buffer.
      Specified by:
      minimumCapacity in class IoBuffer
    • capacity

      public final int capacity()
      Specified by:
      capacity in class IoBuffer
      See Also:
    • capacity

      public final IoBuffer capacity(int newCapacity)
      Increases the capacity of this buffer. If the new capacity is less than or equal to the current capacity, this method returns silently. If the new capacity is greater than the current capacity, the buffer is reallocated while retaining the position, limit, mark and the content of the buffer.
      Specified by:
      capacity in class IoBuffer
    • isAutoExpand

      public final boolean isAutoExpand()
      Returns true if and only if autoExpand is turned on.
      Specified by:
      isAutoExpand in class IoBuffer
    • isAutoShrink

      public final boolean isAutoShrink()
      Returns true if and only if autoShrink is turned on.
      Specified by:
      isAutoShrink in class IoBuffer
    • isDerived

      public final boolean isDerived()
      returns true if and only if this buffer is derived from other buffer via IoBuffer.duplicate(), IoBuffer.slice() or IoBuffer.asReadOnlyBuffer().
      Specified by:
      isDerived in class IoBuffer
    • setAutoExpand

      public final IoBuffer setAutoExpand(boolean autoExpand)
      Turns on or off autoExpand.
      Specified by:
      setAutoExpand in class IoBuffer
    • setAutoShrink

      public final IoBuffer setAutoShrink(boolean autoShrink)
      Turns on or off autoShrink.
      Specified by:
      setAutoShrink in class IoBuffer
    • expand

      public final IoBuffer expand(int expectedRemaining)
      Changes the capacity and limit of this buffer so this buffer get the specified expectedRemaining room from the current position. This method works even if you didn't set autoExpand to true.
      Specified by:
      expand in class IoBuffer
    • expand

      private IoBuffer expand(int expectedRemaining, boolean autoExpand)
    • expand

      public final IoBuffer expand(int pos, int expectedRemaining)
      Changes the capacity and limit of this buffer so this buffer get the specified expectedRemaining room from the specified position. This method works even if you didn't set autoExpand to true.
      Specified by:
      expand in class IoBuffer
    • expand

      private IoBuffer expand(int pos, int expectedRemaining, boolean autoExpand)
    • shrink

      public final IoBuffer shrink()
      Changes the capacity of this buffer so this buffer occupies as less memory as possible while retaining the position, limit and the buffer content between the position and limit. The capacity of the buffer never becomes less than IoBuffer.minimumCapacity(). The mark is discarded once the capacity changes.
      Specified by:
      shrink in class IoBuffer
    • position

      public final int position()
      Specified by:
      position in class IoBuffer
      See Also:
    • position

      public final IoBuffer position(int newPosition)
      Specified by:
      position in class IoBuffer
      See Also:
    • limit

      public final int limit()
      Specified by:
      limit in class IoBuffer
      See Also:
    • limit

      public final IoBuffer limit(int newLimit)
      Specified by:
      limit in class IoBuffer
      See Also:
    • mark

      public final IoBuffer mark()
      Specified by:
      mark in class IoBuffer
      See Also:
    • markValue

      public final int markValue()
      Returns the position of the current mark. This method returns -1 if no mark is set.
      Specified by:
      markValue in class IoBuffer
    • reset

      public final IoBuffer reset()
      Specified by:
      reset in class IoBuffer
      See Also:
    • clear

      public final IoBuffer clear()
      Specified by:
      clear in class IoBuffer
      See Also:
    • sweep

      public final IoBuffer sweep()
      Clears this buffer and fills its content with NUL. The position is set to zero, the limit is set to the capacity, and the mark is discarded.
      Specified by:
      sweep in class IoBuffer
    • sweep

      public final IoBuffer sweep(byte value)
      double Clears this buffer and fills its content with value. The position is set to zero, the limit is set to the capacity, and the mark is discarded.
      Specified by:
      sweep in class IoBuffer
    • flip

      public final IoBuffer flip()
      Specified by:
      flip in class IoBuffer
      See Also:
    • rewind

      public final IoBuffer rewind()
      Specified by:
      rewind in class IoBuffer
      See Also:
    • remaining

      public final int remaining()
      Specified by:
      remaining in class IoBuffer
      See Also:
    • hasRemaining

      public final boolean hasRemaining()
      Specified by:
      hasRemaining in class IoBuffer
      See Also:
    • get

      public final byte get()
      Specified by:
      get in class IoBuffer
      See Also:
    • getUnsigned

      public final short getUnsigned()
      Reads one unsigned byte as a short integer.
      Specified by:
      getUnsigned in class IoBuffer
    • put

      public final IoBuffer put(byte b)
      Specified by:
      put in class IoBuffer
      See Also:
    • get

      public final byte get(int index)
      Specified by:
      get in class IoBuffer
      See Also:
    • getUnsigned

      public final short getUnsigned(int index)
      Reads one byte as an unsigned short integer.
      Specified by:
      getUnsigned in class IoBuffer
    • put

      public final IoBuffer put(int index, byte b)
      Specified by:
      put in class IoBuffer
      See Also:
    • get

      public final IoBuffer get(byte[] dst, int offset, int length)
      Specified by:
      get in class IoBuffer
      See Also:
    • put

      public final IoBuffer put(ByteBuffer src)
      Writes the content of the specified src into this buffer.
      Specified by:
      put in class IoBuffer
    • put

      public final IoBuffer put(byte[] src, int offset, int length)
      Specified by:
      put in class IoBuffer
      See Also:
    • compact

      public final IoBuffer compact()
      Specified by:
      compact in class IoBuffer
      See Also:
    • order

      public final ByteOrder order()
      Specified by:
      order in class IoBuffer
      See Also:
    • order

      public final IoBuffer order(ByteOrder bo)
      Specified by:
      order in class IoBuffer
      See Also:
    • getChar

      public final char getChar()
      Specified by:
      getChar in class IoBuffer
      See Also:
    • putChar

      public final IoBuffer putChar(char value)
      Specified by:
      putChar in class IoBuffer
      See Also:
    • getChar

      public final char getChar(int index)
      Specified by:
      getChar in class IoBuffer
      See Also:
    • putChar

      public final IoBuffer putChar(int index, char value)
      Specified by:
      putChar in class IoBuffer
      See Also:
    • asCharBuffer

      public final CharBuffer asCharBuffer()
      Specified by:
      asCharBuffer in class IoBuffer
      See Also:
    • getShort

      public final short getShort()
      Specified by:
      getShort in class IoBuffer
      See Also:
    • putShort

      public final IoBuffer putShort(short value)
      Specified by:
      putShort in class IoBuffer
      See Also:
    • getShort

      public final short getShort(int index)
      Specified by:
      getShort in class IoBuffer
      See Also:
    • putShort

      public final IoBuffer putShort(int index, short value)
      Specified by:
      putShort in class IoBuffer
      See Also:
    • asShortBuffer

      public final ShortBuffer asShortBuffer()
      Specified by:
      asShortBuffer in class IoBuffer
      See Also:
    • getInt

      public final int getInt()
      Specified by:
      getInt in class IoBuffer
      See Also:
    • putInt

      public final IoBuffer putInt(int value)
      Specified by:
      putInt in class IoBuffer
      See Also:
    • getInt

      public final int getInt(int index)
      Specified by:
      getInt in class IoBuffer
      See Also:
    • putInt

      public final IoBuffer putInt(int index, int value)
      Specified by:
      putInt in class IoBuffer
      See Also:
    • asIntBuffer

      public final IntBuffer asIntBuffer()
      Specified by:
      asIntBuffer in class IoBuffer
      See Also:
    • getLong

      public final long getLong()
      Specified by:
      getLong in class IoBuffer
      See Also:
    • putLong

      public final IoBuffer putLong(long value)
      Specified by:
      putLong in class IoBuffer
      See Also:
    • getLong

      public final long getLong(int index)
      Specified by:
      getLong in class IoBuffer
      See Also:
    • putLong

      public final IoBuffer putLong(int index, long value)
      Specified by:
      putLong in class IoBuffer
      See Also:
    • asLongBuffer

      public final LongBuffer asLongBuffer()
      Specified by:
      asLongBuffer in class IoBuffer
      See Also:
    • getFloat

      public final float getFloat()
      Specified by:
      getFloat in class IoBuffer
      See Also:
    • putFloat

      public final IoBuffer putFloat(float value)
      Specified by:
      putFloat in class IoBuffer
      See Also:
    • getFloat

      public final float getFloat(int index)
      Specified by:
      getFloat in class IoBuffer
      See Also:
    • putFloat

      public final IoBuffer putFloat(int index, float value)
      Specified by:
      putFloat in class IoBuffer
      See Also:
    • asFloatBuffer

      public final FloatBuffer asFloatBuffer()
      Specified by:
      asFloatBuffer in class IoBuffer
      See Also:
    • getDouble

      public final double getDouble()
      Specified by:
      getDouble in class IoBuffer
      See Also:
    • putDouble

      public final IoBuffer putDouble(double value)
      Specified by:
      putDouble in class IoBuffer
      See Also:
    • getDouble

      public final double getDouble(int index)
      Specified by:
      getDouble in class IoBuffer
      See Also:
    • putDouble

      public final IoBuffer putDouble(int index, double value)
      Specified by:
      putDouble in class IoBuffer
      See Also:
    • asDoubleBuffer

      public final DoubleBuffer asDoubleBuffer()
      Specified by:
      asDoubleBuffer in class IoBuffer
      See Also:
    • asReadOnlyBuffer

      public final IoBuffer asReadOnlyBuffer()
      Specified by:
      asReadOnlyBuffer in class IoBuffer
      See Also:
    • asReadOnlyBuffer0

      protected abstract IoBuffer asReadOnlyBuffer0()
      Implement this method to return the unexpandable read only version of this buffer.
    • duplicate

      public final IoBuffer duplicate()
      Specified by:
      duplicate in class IoBuffer
      See Also:
    • duplicate0

      protected abstract IoBuffer duplicate0()
      Implement this method to return the unexpandable duplicate of this buffer.
    • slice

      public final IoBuffer slice()
      Specified by:
      slice in class IoBuffer
      See Also:
    • getSlice

      public final IoBuffer getSlice(int index, int length)
      TODO document me.
      Specified by:
      getSlice in class IoBuffer
    • getSlice

      public final IoBuffer getSlice(int length)
      TODO document me.
      Specified by:
      getSlice in class IoBuffer
    • slice0

      protected abstract IoBuffer slice0()
      Implement this method to return the unexpandable slice of this buffer.
    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object
    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object
    • compareTo

      public int compareTo(IoBuffer that)
    • toString

      public String toString()
      Overrides:
      toString in class Object
    • get

      public IoBuffer get(byte[] dst)
      Specified by:
      get in class IoBuffer
      See Also:
    • put

      public IoBuffer put(IoBuffer src)
      Writes the content of the specified src into this buffer.
      Specified by:
      put in class IoBuffer
    • put

      public IoBuffer put(byte[] src)
      Specified by:
      put in class IoBuffer
      See Also:
    • getUnsignedShort

      public int getUnsignedShort()
      Reads two bytes unsigned integer.
      Specified by:
      getUnsignedShort in class IoBuffer
    • getUnsignedShort

      public int getUnsignedShort(int index)
      Reads two bytes unsigned integer.
      Specified by:
      getUnsignedShort in class IoBuffer
    • getUnsignedInt

      public long getUnsignedInt()
      Reads four bytes unsigned integer.
      Specified by:
      getUnsignedInt in class IoBuffer
    • getMediumInt

      public int getMediumInt()
      Relative get method for reading a medium int value.

      Reads the next three bytes at this buffer's current position, composing them into an int value according to the current byte order, and then increments the position by three.

      Specified by:
      getMediumInt in class IoBuffer
      Returns:
      The medium int value at the buffer's current position
    • getUnsignedMediumInt

      public int getUnsignedMediumInt()
      Relative get method for reading an unsigned medium int value.

      Reads the next three bytes at this buffer's current position, composing them into an int value according to the current byte order, and then increments the position by three.

      Specified by:
      getUnsignedMediumInt in class IoBuffer
      Returns:
      The unsigned medium int value at the buffer's current position
    • getMediumInt

      public int getMediumInt(int index)
      Absolute get method for reading a medium int value.

      Reads the next three bytes at this buffer's current position, composing them into an int value according to the current byte order.

      Specified by:
      getMediumInt in class IoBuffer
      Parameters:
      index - The index from which the medium int will be read
      Returns:
      The medium int value at the given index
    • getUnsignedMediumInt

      public int getUnsignedMediumInt(int index)
      Absolute get method for reading an unsigned medium int value.

      Reads the next three bytes at this buffer's current position, composing them into an int value according to the current byte order.

      Specified by:
      getUnsignedMediumInt in class IoBuffer
      Parameters:
      index - The index from which the unsigned medium int will be read
      Returns:
      The unsigned medium int value at the given index
    • getMediumInt

      private int getMediumInt(byte b1, byte b2, byte b3)
    • putMediumInt

      public IoBuffer putMediumInt(int value)
      Relative put method for writing a medium int value.

      Writes three bytes containing the given int value, in the current byte order, into this buffer at the current position, and then increments the position by three.

      Specified by:
      putMediumInt in class IoBuffer
      Parameters:
      value - The medium int value to be written
      Returns:
      This buffer
    • putMediumInt

      public IoBuffer putMediumInt(int index, int value)
      Absolute put method for writing a medium int value.

      Writes three bytes containing the given int value, in the current byte order, into this buffer at the given index.

      Specified by:
      putMediumInt in class IoBuffer
      Parameters:
      index - The index at which the bytes will be written
      value - The medium int value to be written
      Returns:
      This buffer
    • getUnsignedInt

      public long getUnsignedInt(int index)
      Reads four bytes unsigned integer.
      Specified by:
      getUnsignedInt in class IoBuffer
    • asInputStream

      public InputStream asInputStream()
      Returns an InputStream that reads the data from this buffer. InputStream.read() returns -1 if the buffer position reaches to the limit.
      Specified by:
      asInputStream in class IoBuffer
    • asOutputStream

      public OutputStream asOutputStream()
      Returns an OutputStream that appends the data into this buffer. Please note that the OutputStream.write(int) will throw a BufferOverflowException instead of an IOException in case of buffer overflow. Please set autoExpand property by calling IoBuffer.setAutoExpand(boolean) to prevent the unexpected runtime exception.
      Specified by:
      asOutputStream in class IoBuffer
    • getHexDump

      public String getHexDump()
      Returns hexdump of this buffer. The data and pointer are not changed as a result of this method call.
      Specified by:
      getHexDump in class IoBuffer
      Returns:
      hexidecimal representation of this buffer
    • getHexDump

      public String getHexDump(int lengthLimit)
      Return hexdump of this buffer with limited length.
      Specified by:
      getHexDump in class IoBuffer
      Parameters:
      lengthLimit - The maximum number of bytes to dump from the current buffer position.
      Returns:
      hexidecimal representation of this buffer
    • getString

      public String getString(CharsetDecoder decoder) throws CharacterCodingException
      Reads a NUL-terminated string from this buffer using the specified decoder and returns it. This method reads until the limit of this buffer if no NUL is found.
      Specified by:
      getString in class IoBuffer
      Throws:
      CharacterCodingException
    • getString

      public String getString(int fieldSize, CharsetDecoder decoder) throws CharacterCodingException
      Reads a NUL-terminated string from this buffer using the specified decoder and returns it.
      Specified by:
      getString in class IoBuffer
      Parameters:
      fieldSize - the maximum number of bytes to read
      Throws:
      CharacterCodingException
    • putString

      public IoBuffer putString(CharSequence val, CharsetEncoder encoder) throws CharacterCodingException
      Writes the content of in into this buffer using the specified encoder . This method doesn't terminate string with NUL. You have to do it by yourself.
      Specified by:
      putString in class IoBuffer
      Throws:
      CharacterCodingException
    • putString

      public IoBuffer putString(CharSequence val, int fieldSize, CharsetEncoder encoder) throws CharacterCodingException
      Writes the content of in into this buffer as a NUL-terminated string using the specified encoder.

      If the charset name of the encoder is UTF-16, you cannot specify odd fieldSize, and this method will append two NULs as a terminator.

      Please note that this method doesn't terminate with NUL if the input string is longer than fieldSize.

      Specified by:
      putString in class IoBuffer
      Parameters:
      fieldSize - the maximum number of bytes to write
      Throws:
      CharacterCodingException
    • getPrefixedString

      public String getPrefixedString(CharsetDecoder decoder) throws CharacterCodingException
      Reads a string which has a 16-bit length field before the actual encoded string, using the specified decoder and returns it. This method is a shortcut for getPrefixedString(2, decoder).
      Specified by:
      getPrefixedString in class IoBuffer
      Throws:
      CharacterCodingException
    • getPrefixedString

      public String getPrefixedString(int prefixLength, CharsetDecoder decoder) throws CharacterCodingException
      Reads a string which has a length field before the actual encoded string, using the specified decoder and returns it.
      Specified by:
      getPrefixedString in class IoBuffer
      Parameters:
      prefixLength - the length of the length field (1, 2, or 4)
      decoder - the decoder to use for decoding the string
      Returns:
      the prefixed string
      Throws:
      CharacterCodingException - when decoding fails
      BufferUnderflowException - when there is not enough data available
    • putPrefixedString

      public IoBuffer putPrefixedString(CharSequence in, CharsetEncoder encoder) throws CharacterCodingException
      Writes the content of in into this buffer as a string which has a 16-bit length field before the actual encoded string, using the specified encoder. This method is a shortcut for putPrefixedString(in, 2, 0, encoder).
      Specified by:
      putPrefixedString in class IoBuffer
      Throws:
      CharacterCodingException
    • putPrefixedString

      public IoBuffer putPrefixedString(CharSequence in, int prefixLength, CharsetEncoder encoder) throws CharacterCodingException
      Writes the content of in into this buffer as a string which has a 16-bit length field before the actual encoded string, using the specified encoder. This method is a shortcut for putPrefixedString(in, prefixLength, 0, encoder).
      Specified by:
      putPrefixedString in class IoBuffer
      Parameters:
      prefixLength - the length of the length field (1, 2, or 4)
      Throws:
      CharacterCodingException
    • putPrefixedString

      public IoBuffer putPrefixedString(CharSequence in, int prefixLength, int padding, CharsetEncoder encoder) throws CharacterCodingException
      Writes the content of in into this buffer as a string which has a 16-bit length field before the actual encoded string, using the specified encoder. This method is a shortcut for putPrefixedString(in, prefixLength, padding, ( byte ) 0, encoder) .
      Specified by:
      putPrefixedString in class IoBuffer
      Parameters:
      prefixLength - the length of the length field (1, 2, or 4)
      padding - the number of padded NULs (1 (or 0), 2, or 4)
      Throws:
      CharacterCodingException
    • putPrefixedString

      public IoBuffer putPrefixedString(CharSequence val, int prefixLength, int padding, byte padValue, CharsetEncoder encoder) throws CharacterCodingException
      Writes the content of in into this buffer as a string which has a 16-bit length field before the actual encoded string, using the specified encoder.
      Specified by:
      putPrefixedString in class IoBuffer
      Parameters:
      prefixLength - the length of the length field (1, 2, or 4)
      padding - the number of padded bytes (1 (or 0), 2, or 4)
      padValue - the value of padded bytes
      Throws:
      CharacterCodingException
    • getObject

      public Object getObject() throws ClassNotFoundException
      Reads a Java object from the buffer using the context ClassLoader of the current thread.
      Specified by:
      getObject in class IoBuffer
      Throws:
      ClassNotFoundException
    • getObject

      public Object getObject(ClassLoader classLoader) throws ClassNotFoundException
      Reads a Java object from the buffer using the specified classLoader.
      Specified by:
      getObject in class IoBuffer
      Throws:
      ClassNotFoundException
    • putObject

      public IoBuffer putObject(Object o)
      Writes the specified Java object to the buffer.
      Specified by:
      putObject in class IoBuffer
    • prefixedDataAvailable

      public boolean prefixedDataAvailable(int prefixLength)
      Returns true if this buffer contains a data which has a data length as a prefix and the buffer has remaining data as enough as specified in the data length field. This method is identical with prefixedDataAvailable( prefixLength, Integer.MAX_VALUE ). Please not that using this method can allow DoS (Denial of Service) attack in case the remote peer sends too big data length value. It is recommended to use IoBuffer.prefixedDataAvailable(int, int) instead.
      Specified by:
      prefixedDataAvailable in class IoBuffer
      Parameters:
      prefixLength - the length of the prefix field (1, 2, or 4)
    • prefixedDataAvailable

      public boolean prefixedDataAvailable(int prefixLength, int maxDataLength)
      Returns true if this buffer contains a data which has a data length as a prefix and the buffer has remaining data as enough as specified in the data length field.
      Specified by:
      prefixedDataAvailable in class IoBuffer
      Parameters:
      prefixLength - the length of the prefix field (1, 2, or 4)
      maxDataLength - the allowed maximum of the read data length
    • indexOf

      public int indexOf(byte b)
      Returns the first occurence position of the specified byte from the current position to the current limit.
      Specified by:
      indexOf in class IoBuffer
      Returns:
      -1 if the specified byte is not found
    • skip

      public IoBuffer skip(int size)
      Forwards the position of this buffer as the specified size bytes.
      Specified by:
      skip in class IoBuffer
    • fill

      public IoBuffer fill(byte value, int size)
      Fills this buffer with the specified value. This method moves buffer position forward.
      Specified by:
      fill in class IoBuffer
    • fillAndReset

      public IoBuffer fillAndReset(byte value, int size)
      Fills this buffer with the specified value. This method does not change buffer position.
      Specified by:
      fillAndReset in class IoBuffer
    • fill

      public IoBuffer fill(int size)
      Fills this buffer with NUL (0x00). This method moves buffer position forward.
      Specified by:
      fill in class IoBuffer
    • fillAndReset

      public IoBuffer fillAndReset(int size)
      Fills this buffer with NUL (0x00). This method does not change buffer position.
      Specified by:
      fillAndReset in class IoBuffer
    • getEnum

      public <E extends Enum<E>> E getEnum(Class<E> enumClass)
      Reads a byte from the buffer and returns the correlating enum constant defined by the specified enum type.
      Specified by:
      getEnum in class IoBuffer
      Type Parameters:
      E - The enum type to return
      Parameters:
      enumClass - The enum's class object
    • getEnum

      public <E extends Enum<E>> E getEnum(int index, Class<E> enumClass)
      Reads a byte from the buffer and returns the correlating enum constant defined by the specified enum type.
      Specified by:
      getEnum in class IoBuffer
      Type Parameters:
      E - The enum type to return
      Parameters:
      index - the index from which the byte will be read
      enumClass - The enum's class object
    • getEnumShort

      public <E extends Enum<E>> E getEnumShort(Class<E> enumClass)
      Reads a short from the buffer and returns the correlating enum constant defined by the specified enum type.
      Specified by:
      getEnumShort in class IoBuffer
      Type Parameters:
      E - The enum type to return
      Parameters:
      enumClass - The enum's class object
    • getEnumShort

      public <E extends Enum<E>> E getEnumShort(int index, Class<E> enumClass)
      Reads a short from the buffer and returns the correlating enum constant defined by the specified enum type.
      Specified by:
      getEnumShort in class IoBuffer
      Type Parameters:
      E - The enum type to return
      Parameters:
      index - the index from which the bytes will be read
      enumClass - The enum's class object
    • getEnumInt

      public <E extends Enum<E>> E getEnumInt(Class<E> enumClass)
      Reads an int from the buffer and returns the correlating enum constant defined by the specified enum type.
      Specified by:
      getEnumInt in class IoBuffer
      Type Parameters:
      E - The enum type to return
      Parameters:
      enumClass - The enum's class object
    • getEnumInt

      public <E extends Enum<E>> E getEnumInt(int index, Class<E> enumClass)
      Reads an int from the buffer and returns the correlating enum constant defined by the specified enum type.
      Specified by:
      getEnumInt in class IoBuffer
      Type Parameters:
      E - The enum type to return
      Parameters:
      index - the index from which the bytes will be read
      enumClass - The enum's class object
    • putEnum

      public IoBuffer putEnum(Enum<?> e)
      Writes an enum's ordinal value to the buffer as a byte.
      Specified by:
      putEnum in class IoBuffer
      Parameters:
      e - The enum to write to the buffer
    • putEnum

      public IoBuffer putEnum(int index, Enum<?> e)
      Writes an enum's ordinal value to the buffer as a byte.
      Specified by:
      putEnum in class IoBuffer
      Parameters:
      index - The index at which the byte will be written
      e - The enum to write to the buffer
    • putEnumShort

      public IoBuffer putEnumShort(Enum<?> e)
      Writes an enum's ordinal value to the buffer as a short.
      Specified by:
      putEnumShort in class IoBuffer
      Parameters:
      e - The enum to write to the buffer
    • putEnumShort

      public IoBuffer putEnumShort(int index, Enum<?> e)
      Writes an enum's ordinal value to the buffer as a short.
      Specified by:
      putEnumShort in class IoBuffer
      Parameters:
      index - The index at which the bytes will be written
      e - The enum to write to the buffer
    • putEnumInt

      public IoBuffer putEnumInt(Enum<?> e)
      Writes an enum's ordinal value to the buffer as an integer.
      Specified by:
      putEnumInt in class IoBuffer
      Parameters:
      e - The enum to write to the buffer
    • putEnumInt

      public IoBuffer putEnumInt(int index, Enum<?> e)
      Writes an enum's ordinal value to the buffer as an integer.
      Specified by:
      putEnumInt in class IoBuffer
      Parameters:
      index - The index at which the bytes will be written
      e - The enum to write to the buffer
    • toEnum

      private <E> E toEnum(Class<E> enumClass, int i)
    • enumConversionErrorMessage

      private String enumConversionErrorMessage(Enum<?> e, String type)
    • getEnumSet

      public <E extends Enum<E>> EnumSet<E> getEnumSet(Class<E> enumClass)
      Reads a byte sized bit vector and converts it to an EnumSet.

      Each bit is mapped to a value in the specified enum. The least significant bit maps to the first entry in the specified enum and each subsequent bit maps to each subsequent bit as mapped to the subsequent enum value.

      Specified by:
      getEnumSet in class IoBuffer
      Type Parameters:
      E - the enum type
      Parameters:
      enumClass - the enum class used to create the EnumSet
      Returns:
      the EnumSet representation of the bit vector
    • getEnumSet

      public <E extends Enum<E>> EnumSet<E> getEnumSet(int index, Class<E> enumClass)
      Reads a byte sized bit vector and converts it to an EnumSet.
      Specified by:
      getEnumSet in class IoBuffer
      Type Parameters:
      E - the enum type
      Parameters:
      index - the index from which the byte will be read
      enumClass - the enum class used to create the EnumSet
      Returns:
      the EnumSet representation of the bit vector
      See Also:
    • getEnumSetShort

      public <E extends Enum<E>> EnumSet<E> getEnumSetShort(Class<E> enumClass)
      Reads a short sized bit vector and converts it to an EnumSet.
      Specified by:
      getEnumSetShort in class IoBuffer
      Type Parameters:
      E - the enum type
      Parameters:
      enumClass - the enum class used to create the EnumSet
      Returns:
      the EnumSet representation of the bit vector
      See Also:
    • getEnumSetShort

      public <E extends Enum<E>> EnumSet<E> getEnumSetShort(int index, Class<E> enumClass)
      Reads a short sized bit vector and converts it to an EnumSet.
      Specified by:
      getEnumSetShort in class IoBuffer
      Type Parameters:
      E - the enum type
      Parameters:
      index - the index from which the bytes will be read
      enumClass - the enum class used to create the EnumSet
      Returns:
      the EnumSet representation of the bit vector
      See Also:
    • getEnumSetInt

      public <E extends Enum<E>> EnumSet<E> getEnumSetInt(Class<E> enumClass)
      Reads an int sized bit vector and converts it to an EnumSet.
      Specified by:
      getEnumSetInt in class IoBuffer
      Type Parameters:
      E - the enum type
      Parameters:
      enumClass - the enum class used to create the EnumSet
      Returns:
      the EnumSet representation of the bit vector
      See Also:
    • getEnumSetInt

      public <E extends Enum<E>> EnumSet<E> getEnumSetInt(int index, Class<E> enumClass)
      Reads an int sized bit vector and converts it to an EnumSet.
      Specified by:
      getEnumSetInt in class IoBuffer
      Type Parameters:
      E - the enum type
      Parameters:
      index - the index from which the bytes will be read
      enumClass - the enum class used to create the EnumSet
      Returns:
      the EnumSet representation of the bit vector
      See Also:
    • getEnumSetLong

      public <E extends Enum<E>> EnumSet<E> getEnumSetLong(Class<E> enumClass)
      Reads a long sized bit vector and converts it to an EnumSet.
      Specified by:
      getEnumSetLong in class IoBuffer
      Type Parameters:
      E - the enum type
      Parameters:
      enumClass - the enum class used to create the EnumSet
      Returns:
      the EnumSet representation of the bit vector
      See Also:
    • getEnumSetLong

      public <E extends Enum<E>> EnumSet<E> getEnumSetLong(int index, Class<E> enumClass)
      Reads a long sized bit vector and converts it to an EnumSet.
      Specified by:
      getEnumSetLong in class IoBuffer
      Type Parameters:
      E - the enum type
      Parameters:
      index - the index from which the bytes will be read
      enumClass - the enum class used to create the EnumSet
      Returns:
      the EnumSet representation of the bit vector
      See Also:
    • toEnumSet

      private <E extends Enum<E>> EnumSet<E> toEnumSet(Class<E> clazz, long vector)
    • putEnumSet

      public <E extends Enum<E>> IoBuffer putEnumSet(Set<E> set)
      Writes the specified Set to the buffer as a byte sized bit vector.
      Specified by:
      putEnumSet in class IoBuffer
      Type Parameters:
      E - the enum type of the Set
      Parameters:
      set - the enum set to write to the buffer
    • putEnumSet

      public <E extends Enum<E>> IoBuffer putEnumSet(int index, Set<E> set)
      Writes the specified Set to the buffer as a byte sized bit vector.
      Specified by:
      putEnumSet in class IoBuffer
      Type Parameters:
      E - the enum type of the Set
      Parameters:
      index - the index at which the byte will be written
      set - the enum set to write to the buffer
    • putEnumSetShort

      public <E extends Enum<E>> IoBuffer putEnumSetShort(Set<E> set)
      Writes the specified Set to the buffer as a short sized bit vector.
      Specified by:
      putEnumSetShort in class IoBuffer
      Type Parameters:
      E - the enum type of the Set
      Parameters:
      set - the enum set to write to the buffer
    • putEnumSetShort

      public <E extends Enum<E>> IoBuffer putEnumSetShort(int index, Set<E> set)
      Writes the specified Set to the buffer as a short sized bit vector.
      Specified by:
      putEnumSetShort in class IoBuffer
      Type Parameters:
      E - the enum type of the Set
      Parameters:
      index - the index at which the bytes will be written
      set - the enum set to write to the buffer
    • putEnumSetInt

      public <E extends Enum<E>> IoBuffer putEnumSetInt(Set<E> set)
      Writes the specified Set to the buffer as an int sized bit vector.
      Specified by:
      putEnumSetInt in class IoBuffer
      Type Parameters:
      E - the enum type of the Set
      Parameters:
      set - the enum set to write to the buffer
    • putEnumSetInt

      public <E extends Enum<E>> IoBuffer putEnumSetInt(int index, Set<E> set)
      Writes the specified Set to the buffer as an int sized bit vector.
      Specified by:
      putEnumSetInt in class IoBuffer
      Type Parameters:
      E - the enum type of the Set
      Parameters:
      index - the index at which the bytes will be written
      set - the enum set to write to the buffer
    • putEnumSetLong

      public <E extends Enum<E>> IoBuffer putEnumSetLong(Set<E> set)
      Writes the specified Set to the buffer as a long sized bit vector.
      Specified by:
      putEnumSetLong in class IoBuffer
      Type Parameters:
      E - the enum type of the Set
      Parameters:
      set - the enum set to write to the buffer
    • putEnumSetLong

      public <E extends Enum<E>> IoBuffer putEnumSetLong(int index, Set<E> set)
      Writes the specified Set to the buffer as a long sized bit vector.
      Specified by:
      putEnumSetLong in class IoBuffer
      Type Parameters:
      E - the enum type of the Set
      Parameters:
      index - the index at which the bytes will be written
      set - the enum set to write to the buffer
    • toLong

      private <E extends Enum<E>> long toLong(Set<E> set)
    • autoExpand

      private IoBuffer autoExpand(int expectedRemaining)
      This method forwards the call to expand(int) only when autoExpand property is true.
    • autoExpand

      private IoBuffer autoExpand(int pos, int expectedRemaining)
      This method forwards the call to expand(int) only when autoExpand property is true.
    • checkFieldSize

      private static void checkFieldSize(int fieldSize)