Package com.google.code.yanf4j.buffer

Class IoBuffer

  • All Implemented Interfaces:
    Comparable<IoBuffer>
    Direct Known Subclasses:
    AbstractIoBuffer, IoBufferWrapper
    public abstract class IoBuffer
extends Object
implements Comparable<IoBuffer>
    A byte buffer used by MINA applications.

    This is a replacement for ByteBuffer. Please refer to ByteBuffer documentation for preliminary usage. MINA does not use NIO ByteBuffer directly for two reasons:

    • It doesn't provide useful getters and putters such as fill, get/putString, and get/putAsciiInt() enough.
    • It is difficult to write variable-length data due to its fixed capacity

    Allocation

    You can allocate a new heap buffer. 

     IoBuffer buf = IoBuffer.allocate(1024, false);
    you can also allocate a new direct buffer: 
     IoBuffer buf = IoBuffer.allocate(1024, true);
    or you can set the default buffer type. 
     // Allocate heap buffer by default.
 IoBuffer.setUseDirectBuffer(false);
 // A new heap buffer is returned.
 IoBuffer buf = IoBuffer.allocate(1024);

    Wrapping existing NIO buffers and arrays

    This class provides a few wrap(...) methods that wraps any NIO buffers and byte arrays.

    AutoExpand

    Writing variable-length data using NIO ByteBuffers is not really easy, and it is because its size is fixed. IoBuffer introduces autoExpand property. If autoExpand property is true, you never get BufferOverflowException or IndexOutOfBoundsException (except when index is negative). It automatically expands its capacity and limit value. For example: 

     String greeting = messageBundle.getMessage("hello");
 IoBuffer buf = IoBuffer.allocate(16);
 // Turn on autoExpand (it is off by default)
 buf.setAutoExpand(true);
 buf.putString(greeting, utf8encoder);
    The underlying ByteBuffer is reallocated by IoBuffer behind the scene if the encoded data is larger than 16 bytes in the example above. Its capacity will double, and its limit will increase to the last position the string is written.

    AutoShrink

    You might also want to decrease the capacity of the buffer when most of the allocated memory area is not being used. IoBuffer provides autoShrink property to take care of this issue. If autoShrink is turned on, IoBuffer halves the capacity of the buffer when compact() is invoked and only 1/4 or less of the current capacity is being used.

    You can also shrink() method manually to shrink the capacity of the buffer.

    The underlying ByteBuffer is reallocated by IoBuffer behind the scene, and therefore buf() will return a different ByteBuffer instance once capacity changes. Please also note compact() or shrink() will not decrease the capacity if the new capacity is less than the minimumCapacity() of the buffer.

    Derived Buffers

    Derived buffers are the buffers which were created by duplicate(), slice(), or asReadOnlyBuffer(). They are useful especially when you broadcast the same messages to multiple IoSessions. Please note that the buffer derived from and its derived buffers are not both auto-expandable neither auto-shrinkable. Trying to call setAutoExpand(boolean) or setAutoShrink(boolean) with true parameter will raise an IllegalStateException.

    Changing Buffer Allocation Policy

    IoBufferAllocator interface lets you override the default buffer management behavior. There are two allocators provided out-of-the-box:

    You can implement your own allocator and use it by calling setAllocator(IoBufferAllocator).

    Version:
    $Rev: 748525 $, $Date: 2009-02-27 14:45:31 +0100 (Fri, 27 Feb 2009) $
    Author:
    The Apache MINA Project (dev@mina.apache.org)

    • Constructor Detail

      • IoBuffer

        protected IoBuffer()
        Creates a new instance. This is an empty constructor.

    • Method Detail

      • getAllocator

        public static IoBufferAllocator getAllocator()
        Returns the allocator used by existing and new buffers

      • setAllocator

        public static void setAllocator​(IoBufferAllocator newAllocator)
        Sets the allocator used by existing and new buffers

      • isUseDirectBuffer

        public static boolean isUseDirectBuffer()
        Returns true if and only if a direct buffer is allocated by default when the type of the new buffer is not specified. The default value is false.

      • setUseDirectBuffer

        public static void setUseDirectBuffer​(boolean useDirectBuffer)
        Sets if a direct buffer should be allocated by default when the type of the new buffer is not specified. The default value is false.

      • allocate

        public static IoBuffer allocate​(int capacity)
        Returns the direct or heap buffer which is capable to store the specified amount of bytes.
        Parameters:
        capacity - the capacity of the buffer
        See Also:
        setUseDirectBuffer(boolean)

      • allocate

        public static IoBuffer allocate​(int capacity,
                                boolean direct)
        Returns the buffer which is capable of the specified size.
        Parameters:
        capacity - the capacity of the buffer
        direct - true to get a direct buffer, false to get a heap buffer.

      • wrap

        public static IoBuffer wrap​(byte[] byteArray)
        Wraps the specified byte array into MINA heap buffer.

      • wrap

        public static IoBuffer wrap​(byte[] byteArray,
                            int offset,
                            int length)
        Wraps the specified byte array into MINA heap buffer.

      • normalizeCapacity

        protected static int normalizeCapacity​(int requestedCapacity)
        Normalizes the specified capacity of the buffer to power of 2, which is often helpful for optimal memory usage and performance. If it is greater than or equal to Integer.MAX_VALUE, it returns Integer.MAX_VALUE. If it is zero, it returns zero.

      • free

        public abstract void free()
        Declares this buffer and all its derived buffers are not used anymore so that it can be reused by some IoBufferAllocator implementations. It is not mandatory to call this method, but you might want to invoke this method for maximum performance.

      • buf

        public abstract ByteBuffer buf()
        Returns the underlying NIO buffer instance.

      • minimumCapacity

        public abstract int minimumCapacity()
        Returns the minimum capacity of this buffer which is used to determine the new capacity of the buffer shrunk by compact() and shrink() operation. The default value is the initial capacity of the buffer.

      • minimumCapacity

        public abstract IoBuffer minimumCapacity​(int minimumCapacity)
        Sets the minimum capacity of this buffer which is used to determine the new capacity of the buffer shrunk by compact() and shrink() operation. The default value is the initial capacity of the buffer.

      • capacity

        public abstract 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.

      • isAutoExpand

        public abstract boolean isAutoExpand()
        Returns true if and only if autoExpand is turned on.

      • setAutoExpand

        public abstract IoBuffer setAutoExpand​(boolean autoExpand)
        Turns on or off autoExpand.

      • isAutoShrink

        public abstract boolean isAutoShrink()
        Returns true if and only if autoShrink is turned on.

      • setAutoShrink

        public abstract IoBuffer setAutoShrink​(boolean autoShrink)
        Turns on or off autoShrink.

      • expand

        public abstract 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.

      • expand

        public abstract IoBuffer expand​(int position,
                                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.

      • shrink

        public abstract 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 minimumCapacity(). The mark is discarded once the capacity changes.

      • markValue

        public abstract int markValue()
        Returns the position of the current mark. This method returns -1 if no mark is set.

      • sweep

        public abstract 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.

      • sweep

        public abstract 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.

      • getUnsigned

        public abstract short getUnsigned()
        Reads one unsigned byte as a short integer.

      • getUnsigned

        public abstract short getUnsigned​(int index)
        Reads one byte as an unsigned short integer.

      • getSlice

        public abstract IoBuffer getSlice​(int index,
                                  int length)
        TODO document me.

      • getSlice

        public abstract IoBuffer getSlice​(int length)
        TODO document me.

      • put

        public abstract IoBuffer put​(ByteBuffer src)
        Writes the content of the specified src into this buffer.

      • put

        public abstract IoBuffer put​(IoBuffer src)
        Writes the content of the specified src into this buffer.

      • getUnsignedShort

        public abstract int getUnsignedShort()
        Reads two bytes unsigned integer.

      • getUnsignedShort

        public abstract int getUnsignedShort​(int index)
        Reads two bytes unsigned integer.

      • getUnsignedInt

        public abstract long getUnsignedInt()
        Reads four bytes unsigned integer.

      • getMediumInt

        public abstract 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.

        Returns:
        The medium int value at the buffer's current position

      • getUnsignedMediumInt

        public abstract 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.

        Returns:
        The unsigned medium int value at the buffer's current position

      • getMediumInt

        public abstract 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.

        Parameters:
        index - The index from which the medium int will be read
        Returns:
        The medium int value at the given index
        Throws:
        IndexOutOfBoundsException - If index is negative or not smaller than the buffer's limit

      • getUnsignedMediumInt

        public abstract 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.

        Parameters:
        index - The index from which the unsigned medium int will be read
        Returns:
        The unsigned medium int value at the given index
        Throws:
        IndexOutOfBoundsException - If index is negative or not smaller than the buffer's limit

      • putMediumInt

        public abstract 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.

        Parameters:
        value - The medium int value to be written
        Returns:
        This buffer
        Throws:
        BufferOverflowException - If there are fewer than three bytes remaining in this buffer
        ReadOnlyBufferException - If this buffer is read-only

      • putMediumInt

        public abstract 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.

        Parameters:
        index - The index at which the bytes will be written
        value - The medium int value to be written
        Returns:
        This buffer
        Throws:
        IndexOutOfBoundsException - If index is negative or not smaller than the buffer's limit, minus three
        ReadOnlyBufferException - If this buffer is read-only

      • getUnsignedInt

        public abstract long getUnsignedInt​(int index)
        Reads four bytes unsigned integer.

      • getHexDump

        public abstract String getHexDump()
        Returns hexdump of this buffer. The data and pointer are not changed as a result of this method call.
        Returns:
        hexidecimal representation of this buffer

      • getHexDump

        public abstract String getHexDump​(int lengthLimit)
        Return hexdump of this buffer with limited length.
        Parameters:
        lengthLimit - The maximum number of bytes to dump from the current buffer position.
        Returns:
        hexidecimal representation of this buffer

      • putString

        public abstract 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.

        Parameters:
        fieldSize - the maximum number of bytes to write
        Throws:
        CharacterCodingException

      • getPrefixedString

        public abstract 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).
        Throws:
        CharacterCodingException

      • getPrefixedString

        public abstract 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.
        Parameters:
        prefixLength - the length of the length field (1, 2, or 4)
        Throws:
        CharacterCodingException

      • putPrefixedString

        public abstract 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).
        Parameters:
        prefixLength - the length of the length field (1, 2, or 4)
        Throws:
        BufferOverflowException - if the specified string doesn't fit
        CharacterCodingException

      • putPrefixedString

        public abstract 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) .
        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:
        BufferOverflowException - if the specified string doesn't fit
        CharacterCodingException

      • putPrefixedString

        public abstract 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.
        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:
        BufferOverflowException - if the specified string doesn't fit
        CharacterCodingException

      • putObject

        public abstract IoBuffer putObject​(Object o)
        Writes the specified Java object to the buffer.

      • prefixedDataAvailable

        public abstract 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 prefixedDataAvailable(int, int) instead.
        Parameters:
        prefixLength - the length of the prefix field (1, 2, or 4)
        Throws:
        IllegalArgumentException - if prefixLength is wrong
        BufferDataException - if data length is negative

      • prefixedDataAvailable

        public abstract 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.
        Parameters:
        prefixLength - the length of the prefix field (1, 2, or 4)
        maxDataLength - the allowed maximum of the read data length
        Throws:
        IllegalArgumentException - if prefixLength is wrong
        BufferDataException - if data length is negative or greater then maxDataLength

      • indexOf

        public abstract int indexOf​(byte b)
        Returns the first occurence position of the specified byte from the current position to the current limit.
        Returns:
        -1 if the specified byte is not found

      • skip

        public abstract IoBuffer skip​(int size)
        Forwards the position of this buffer as the specified size bytes.

      • fill

        public abstract IoBuffer fill​(byte value,
                              int size)
        Fills this buffer with the specified value. This method moves buffer position forward.

      • fillAndReset

        public abstract IoBuffer fillAndReset​(byte value,
                                      int size)
        Fills this buffer with the specified value. This method does not change buffer position.

      • fill

        public abstract IoBuffer fill​(int size)
        Fills this buffer with NUL (0x00). This method moves buffer position forward.

      • fillAndReset

        public abstract IoBuffer fillAndReset​(int size)
        Fills this buffer with NUL (0x00). This method does not change buffer position.

      • getEnum

        public abstract <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.
        Type Parameters:
        E - The enum type to return
        Parameters:
        enumClass - The enum's class object

      • getEnum

        public abstract <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.
        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 abstract <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.
        Type Parameters:
        E - The enum type to return
        Parameters:
        enumClass - The enum's class object

      • getEnumShort

        public abstract <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.
        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 abstract <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.
        Type Parameters:
        E - The enum type to return
        Parameters:
        enumClass - The enum's class object

      • getEnumInt

        public abstract <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.
        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 abstract IoBuffer putEnum​(Enum<?> e)
        Writes an enum's ordinal value to the buffer as a byte.
        Parameters:
        e - The enum to write to the buffer

      • putEnum

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

      • putEnumShort

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

      • putEnumShort

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

      • putEnumInt

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

      • putEnumInt

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

      • getEnumSet

        public abstract <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.

        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 abstract <E extends Enum<E>> EnumSet<E> getEnumSet​(int index,
                                                          Class<E> enumClass)
        Reads a byte sized bit vector and converts it to an EnumSet.
        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:
        getEnumSet(Class)

      • getEnumSetShort

        public abstract <E extends Enum<E>> EnumSet<E> getEnumSetShort​(Class<E> enumClass)
        Reads a short sized bit vector and converts it to an EnumSet.
        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:
        getEnumSet(Class)

      • getEnumSetShort

        public abstract <E extends Enum<E>> EnumSet<E> getEnumSetShort​(int index,
                                                               Class<E> enumClass)
        Reads a short sized bit vector and converts it to an EnumSet.
        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:
        getEnumSet(Class)

      • getEnumSetInt

        public abstract <E extends Enum<E>> EnumSet<E> getEnumSetInt​(Class<E> enumClass)
        Reads an int sized bit vector and converts it to an EnumSet.
        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:
        getEnumSet(Class)

      • getEnumSetInt

        public abstract <E extends Enum<E>> EnumSet<E> getEnumSetInt​(int index,
                                                             Class<E> enumClass)
        Reads an int sized bit vector and converts it to an EnumSet.
        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:
        getEnumSet(Class)

      • getEnumSetLong

        public abstract <E extends Enum<E>> EnumSet<E> getEnumSetLong​(Class<E> enumClass)
        Reads a long sized bit vector and converts it to an EnumSet.
        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:
        getEnumSet(Class)

      • getEnumSetLong

        public abstract <E extends Enum<E>> EnumSet<E> getEnumSetLong​(int index,
                                                              Class<E> enumClass)
        Reads a long sized bit vector and converts it to an EnumSet.
        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:
        getEnumSet(Class)

      • putEnumSet

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

      • putEnumSet

        public abstract <E extends Enum<E>> IoBuffer putEnumSet​(int index,
                                                        Set<E> set)
        Writes the specified Set to the buffer as a byte sized bit vector.
        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 abstract <E extends Enum<E>> IoBuffer putEnumSetShort​(Set<E> set)
        Writes the specified Set to the buffer as a short sized bit vector.
        Type Parameters:
        E - the enum type of the Set
        Parameters:
        set - the enum set to write to the buffer

      • putEnumSetShort

        public abstract <E extends Enum<E>> IoBuffer putEnumSetShort​(int index,
                                                             Set<E> set)
        Writes the specified Set to the buffer as a short sized bit vector.
        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 abstract <E extends Enum<E>> IoBuffer putEnumSetInt​(Set<E> set)
        Writes the specified Set to the buffer as an int sized bit vector.
        Type Parameters:
        E - the enum type of the Set
        Parameters:
        set - the enum set to write to the buffer

      • putEnumSetInt

        public abstract <E extends Enum<E>> IoBuffer putEnumSetInt​(int index,
                                                           Set<E> set)
        Writes the specified Set to the buffer as an int sized bit vector.
        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 abstract <E extends Enum<E>> IoBuffer putEnumSetLong​(Set<E> set)
        Writes the specified Set to the buffer as a long sized bit vector.
        Type Parameters:
        E - the enum type of the Set
        Parameters:
        set - the enum set to write to the buffer

      • putEnumSetLong

        public abstract <E extends Enum<E>> IoBuffer putEnumSetLong​(int index,
                                                            Set<E> set)
        Writes the specified Set to the buffer as a long sized bit vector.
        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