Class IoBufferWrapper
- All Implemented Interfaces:
Comparable<IoBuffer>
IoBuffer that wraps a buffer and proxies any operations to it.
You can think this class like a FilterOutputStream. All operations are proxied by default
so that you can extend this class and override existing operations selectively. You can introduce
new operations, too.
- Version:
- $Rev: 671827 $, $Date: 2008-06-26 10:49:48 +0200 (Thu, 26 Jun 2008) $
-
Field Summary
Fields -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionbyte[]array()intReturns anInputStreamthat reads the data from this buffer.Returns anOutputStreamthat appends the data into this buffer.buf()Returns the underlying NIO buffer instance.intcapacity()capacity(int newCapacity) Increases the capacity of this buffer.clear()compact()intbooleanexpand(int expectedRemaining) Changes the capacity and limit of this buffer so this buffer get the specified expectedRemaining room from the current position.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.fill(byte value, int size) Fills this buffer with the specified value.fill(int size) Fills this buffer withNUL (0x00).fillAndReset(byte value, int size) Fills this buffer with the specified value.fillAndReset(int size) Fills this buffer withNUL (0x00).flip()voidfree()Declares this buffer and all its derived buffers are not used anymore so that it can be reused by someIoBufferAllocatorimplementations.byteget()get(byte[] dst) get(byte[] dst, int offset, int length) byteget(int index) chargetChar()chargetChar(int index) doubledoublegetDouble(int index) <E extends Enum<E>>
EReads a byte from the buffer and returns the correlating enum constant defined by the specified enum type.<E extends Enum<E>>
EReads a byte from the buffer and returns the correlating enum constant defined by the specified enum type.<E extends Enum<E>>
EgetEnumInt(int index, Class<E> enumClass) Reads an int from the buffer and returns the correlating enum constant defined by the specified enum type.<E extends Enum<E>>
EgetEnumInt(Class<E> enumClass) Reads an int from the buffer and returns the correlating enum constant defined by the specified enum type.getEnumSet(int index, Class<E> enumClass) Reads a byte sized bit vector and converts it to anEnumSet.getEnumSet(Class<E> enumClass) Reads a byte sized bit vector and converts it to anEnumSet.getEnumSetInt(int index, Class<E> enumClass) Reads an int sized bit vector and converts it to anEnumSet.getEnumSetInt(Class<E> enumClass) Reads an int sized bit vector and converts it to anEnumSet.getEnumSetLong(int index, Class<E> enumClass) Reads a long sized bit vector and converts it to anEnumSet.getEnumSetLong(Class<E> enumClass) Reads a long sized bit vector and converts it to anEnumSet.getEnumSetShort(int index, Class<E> enumClass) Reads a short sized bit vector and converts it to anEnumSet.getEnumSetShort(Class<E> enumClass) Reads a short sized bit vector and converts it to anEnumSet.<E extends Enum<E>>
EgetEnumShort(int index, Class<E> enumClass) Reads a short from the buffer and returns the correlating enum constant defined by the specified enum type.<E extends Enum<E>>
EgetEnumShort(Class<E> enumClass) Reads a short from the buffer and returns the correlating enum constant defined by the specified enum type.floatgetFloat()floatgetFloat(int index) Returns hexdump of this buffer.getHexDump(int lengthLimit) Return hexdump of this buffer with limited length.intgetInt()intgetInt(int index) longgetLong()longgetLong(int index) intRelative get method for reading a medium int value.intgetMediumInt(int index) Absolute get method for reading a medium int value.Reads a Java object from the buffer using the contextClassLoaderof the current thread.getObject(ClassLoader classLoader) Reads a Java object from the buffer using the specified classLoader.Returns the parent buffer that this buffer wrapped.getPrefixedString(int prefixLength, CharsetDecoder decoder) Reads a string which has a length field before the actual encoded string, using the specifieddecoderand returns it.getPrefixedString(CharsetDecoder decoder) Reads a string which has a 16-bit length field before the actual encoded string, using the specifieddecoderand returns it.shortgetShort()shortgetShort(int index) getSlice(int length) TODO document me.getSlice(int index, int length) TODO document me.getString(int fieldSize, CharsetDecoder decoder) Reads aNUL-terminated string from this buffer using the specifieddecoderand returns it.getString(CharsetDecoder decoder) Reads aNUL-terminated string from this buffer using the specifieddecoderand returns it.shortReads one unsigned byte as a short integer.shortgetUnsigned(int index) Reads one byte as an unsigned short integer.longReads four bytes unsigned integer.longgetUnsignedInt(int index) Reads four bytes unsigned integer.intRelative get method for reading an unsigned medium int value.intgetUnsignedMediumInt(int index) Absolute get method for reading an unsigned medium int value.intReads two bytes unsigned integer.intgetUnsignedShort(int index) Reads two bytes unsigned integer.booleanhasArray()inthashCode()booleanintindexOf(byte b) Returns the first occurence position of the specified byte from the current position to the current limit.booleanReturns true if and only if autoExpand is turned on.booleanReturns true if and only if autoShrink is turned on.booleanreturns true if and only if this buffer is derived from other buffer viaIoBuffer.duplicate(),IoBuffer.slice()orIoBuffer.asReadOnlyBuffer().booleanisDirect()booleanintlimit()limit(int newLimit) mark()intReturns the position of the current mark.intReturns the minimum capacity of this buffer which is used to determine the new capacity of the buffer shrunk byIoBuffer.compact()andIoBuffer.shrink()operation.minimumCapacity(int minimumCapacity) Sets the minimum capacity of this buffer which is used to determine the new capacity of the buffer shrunk byIoBuffer.compact()andIoBuffer.shrink()operation.order()intposition()position(int newPosition) booleanprefixedDataAvailable(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.booleanprefixedDataAvailable(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.put(byte b) put(byte[] src) put(byte[] src, int offset, int length) put(int index, byte b) Writes the content of the specified src into this buffer.put(ByteBuffer src) Writes the content of the specified src into this buffer.putChar(char value) putChar(int index, char value) putDouble(double value) putDouble(int index, double value) Writes an enum's ordinal value to the buffer as a byte.Writes an enum's ordinal value to the buffer as a byte.putEnumInt(int index, Enum<?> e) Writes an enum's ordinal value to the buffer as an integer.putEnumInt(Enum<?> e) Writes an enum's ordinal value to the buffer as an integer.putEnumSet(int index, Set<E> set) Writes the specifiedSetto the buffer as a byte sized bit vector.putEnumSet(Set<E> set) Writes the specifiedSetto the buffer as a byte sized bit vector.putEnumSetInt(int index, Set<E> set) Writes the specifiedSetto the buffer as an int sized bit vector.putEnumSetInt(Set<E> set) Writes the specifiedSetto the buffer as an int sized bit vector.putEnumSetLong(int index, Set<E> set) Writes the specifiedSetto the buffer as a long sized bit vector.putEnumSetLong(Set<E> set) Writes the specifiedSetto the buffer as a long sized bit vector.putEnumSetShort(int index, Set<E> set) Writes the specifiedSetto the buffer as a short sized bit vector.putEnumSetShort(Set<E> set) Writes the specifiedSetto the buffer as a short sized bit vector.putEnumShort(int index, Enum<?> e) Writes an enum's ordinal value to the buffer as a short.putEnumShort(Enum<?> e) Writes an enum's ordinal value to the buffer as a short.putFloat(float value) putFloat(int index, float value) putInt(int value) putInt(int index, int value) putLong(int index, long value) putLong(long value) putMediumInt(int value) Relative put method for writing a medium int value.putMediumInt(int index, int value) Absolute put method for writing a medium int value.Writes the specified Java object to the buffer.putPrefixedString(CharSequence in, int prefixLength, int padding, byte padValue, CharsetEncoder encoder) Writes the content ofininto this buffer as a string which has a 16-bit length field before the actual encoded string, using the specifiedencoder.putPrefixedString(CharSequence in, int prefixLength, int padding, CharsetEncoder encoder) Writes the content ofininto this buffer as a string which has a 16-bit length field before the actual encoded string, using the specifiedencoder.putPrefixedString(CharSequence in, int prefixLength, CharsetEncoder encoder) Writes the content ofininto this buffer as a string which has a 16-bit length field before the actual encoded string, using the specifiedencoder.putPrefixedString(CharSequence in, CharsetEncoder encoder) Writes the content ofininto this buffer as a string which has a 16-bit length field before the actual encoded string, using the specifiedencoder.putShort(int index, short value) putShort(short value) putString(CharSequence in, int fieldSize, CharsetEncoder encoder) Writes the content ofininto this buffer as aNUL-terminated string using the specifiedencoder.putString(CharSequence in, CharsetEncoder encoder) Writes the content ofininto this buffer using the specifiedencoder.intreset()rewind()setAutoExpand(boolean autoExpand) Turns on or off autoExpand.setAutoShrink(boolean autoShrink) Turns on or off autoShrink.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.skip(int size) Forwards the position of this buffer as the specifiedsizebytes.slice()sweep()Clears this buffer and fills its content with NUL.sweep(byte value) double Clears this buffer and fills its content with value.toString()Methods inherited from class com.google.code.yanf4j.buffer.IoBuffer
allocate, allocate, getAllocator, isUseDirectBuffer, normalizeCapacity, setAllocator, setUseDirectBuffer, wrap, wrap, wrap
-
Field Details
-
buf
The buffer proxied by this proxy.
-
-
Constructor Details
-
IoBufferWrapper
Create a new instance.- Parameters:
buf- the buffer to be proxied
-
-
Method Details
-
getParentBuffer
Returns the parent buffer that this buffer wrapped. -
isDirect
public boolean isDirect() -
buf
Description copied from class:IoBufferReturns the underlying NIO buffer instance. -
capacity
public int capacity() -
position
public int position() -
position
-
limit
public int limit() -
limit
-
mark
-
reset
-
clear
-
sweep
Description copied from class:IoBufferClears 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
Description copied from class:IoBufferdouble 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. -
flip
-
rewind
-
remaining
public int remaining() -
hasRemaining
public boolean hasRemaining()- Specified by:
hasRemainingin classIoBuffer- See Also:
-
get
public byte get() -
getUnsigned
public short getUnsigned()Description copied from class:IoBufferReads one unsigned byte as a short integer.- Specified by:
getUnsignedin classIoBuffer
-
put
-
get
public byte get(int index) -
getUnsigned
public short getUnsigned(int index) Description copied from class:IoBufferReads one byte as an unsigned short integer.- Specified by:
getUnsignedin classIoBuffer
-
put
-
get
-
getSlice
Description copied from class:IoBufferTODO document me. -
getSlice
Description copied from class:IoBufferTODO document me. -
get
-
put
Description copied from class:IoBufferWrites the content of the specified src into this buffer. -
put
Description copied from class:IoBufferWrites the content of the specified src into this buffer. -
put
-
put
-
compact
-
toString
-
hashCode
public int hashCode() -
equals
-
compareTo
-
order
-
order
-
getChar
public char getChar() -
putChar
-
getChar
public char getChar(int index) -
putChar
-
asCharBuffer
- Specified by:
asCharBufferin classIoBuffer- See Also:
-
getShort
public short getShort() -
getUnsignedShort
public int getUnsignedShort()Description copied from class:IoBufferReads two bytes unsigned integer.- Specified by:
getUnsignedShortin classIoBuffer
-
putShort
-
getShort
public short getShort(int index) -
getUnsignedShort
public int getUnsignedShort(int index) Description copied from class:IoBufferReads two bytes unsigned integer.- Specified by:
getUnsignedShortin classIoBuffer
-
putShort
-
asShortBuffer
- Specified by:
asShortBufferin classIoBuffer- See Also:
-
getInt
public int getInt() -
getUnsignedInt
public long getUnsignedInt()Description copied from class:IoBufferReads four bytes unsigned integer.- Specified by:
getUnsignedIntin classIoBuffer
-
putInt
-
getInt
public int getInt(int index) -
getUnsignedInt
public long getUnsignedInt(int index) Description copied from class:IoBufferReads four bytes unsigned integer.- Specified by:
getUnsignedIntin classIoBuffer
-
putInt
-
asIntBuffer
- Specified by:
asIntBufferin classIoBuffer- See Also:
-
getLong
public long getLong() -
putLong
-
getLong
public long getLong(int index) -
putLong
-
asLongBuffer
- Specified by:
asLongBufferin classIoBuffer- See Also:
-
getFloat
public float getFloat() -
putFloat
-
getFloat
public float getFloat(int index) -
putFloat
-
asFloatBuffer
- Specified by:
asFloatBufferin classIoBuffer- See Also:
-
getDouble
public double getDouble() -
putDouble
-
getDouble
public double getDouble(int index) -
putDouble
-
asDoubleBuffer
- Specified by:
asDoubleBufferin classIoBuffer- See Also:
-
getHexDump
Description copied from class:IoBufferReturns hexdump of this buffer. The data and pointer are not changed as a result of this method call.- Specified by:
getHexDumpin classIoBuffer- Returns:
- hexidecimal representation of this buffer
-
getString
Description copied from class:IoBufferReads aNUL-terminated string from this buffer using the specifieddecoderand returns it.- Specified by:
getStringin classIoBuffer- Parameters:
fieldSize- the maximum number of bytes to read- Throws:
CharacterCodingException
-
getString
Description copied from class:IoBufferReads aNUL-terminated string from this buffer using the specifieddecoderand returns it. This method reads until the limit of this buffer if no NUL is found.- Specified by:
getStringin classIoBuffer- Throws:
CharacterCodingException
-
getPrefixedString
Description copied from class:IoBufferReads a string which has a 16-bit length field before the actual encoded string, using the specifieddecoderand returns it. This method is a shortcut for getPrefixedString(2, decoder).- Specified by:
getPrefixedStringin classIoBuffer- Throws:
CharacterCodingException
-
getPrefixedString
public String getPrefixedString(int prefixLength, CharsetDecoder decoder) throws CharacterCodingException Description copied from class:IoBufferReads a string which has a length field before the actual encoded string, using the specifieddecoderand returns it.- Specified by:
getPrefixedStringin classIoBuffer- Parameters:
prefixLength- the length of the length field (1, 2, or 4)- Throws:
CharacterCodingException
-
putString
public IoBuffer putString(CharSequence in, int fieldSize, CharsetEncoder encoder) throws CharacterCodingException Description copied from class:IoBufferWrites the content ofininto this buffer as aNUL-terminated string using the specifiedencoder.If the charset name of the encoder is UTF-16, you cannot specify odd
fieldSize, and this method will append twoNULs as a terminator.Please note that this method doesn't terminate with
NULif the input string is longer than fieldSize.- Specified by:
putStringin classIoBuffer- Parameters:
fieldSize- the maximum number of bytes to write- Throws:
CharacterCodingException
-
putString
Description copied from class:IoBufferWrites the content ofininto this buffer using the specifiedencoder. This method doesn't terminate string with NUL. You have to do it by yourself.- Specified by:
putStringin classIoBuffer- Throws:
CharacterCodingException
-
putPrefixedString
public IoBuffer putPrefixedString(CharSequence in, CharsetEncoder encoder) throws CharacterCodingException Description copied from class:IoBufferWrites the content ofininto this buffer as a string which has a 16-bit length field before the actual encoded string, using the specifiedencoder. This method is a shortcut for putPrefixedString(in, 2, 0, encoder).- Specified by:
putPrefixedStringin classIoBuffer- Throws:
CharacterCodingException
-
putPrefixedString
public IoBuffer putPrefixedString(CharSequence in, int prefixLength, CharsetEncoder encoder) throws CharacterCodingException Description copied from class:IoBufferWrites the content ofininto this buffer as a string which has a 16-bit length field before the actual encoded string, using the specifiedencoder. This method is a shortcut for putPrefixedString(in, prefixLength, 0, encoder).- Specified by:
putPrefixedStringin classIoBuffer- 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 Description copied from class:IoBufferWrites the content ofininto this buffer as a string which has a 16-bit length field before the actual encoded string, using the specifiedencoder. This method is a shortcut for putPrefixedString(in, prefixLength, padding, ( byte ) 0, encoder) .- Specified by:
putPrefixedStringin classIoBuffer- 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 in, int prefixLength, int padding, byte padValue, CharsetEncoder encoder) throws CharacterCodingException Description copied from class:IoBufferWrites the content ofininto this buffer as a string which has a 16-bit length field before the actual encoded string, using the specifiedencoder.- Specified by:
putPrefixedStringin classIoBuffer- 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
-
skip
Description copied from class:IoBufferForwards the position of this buffer as the specifiedsizebytes. -
fill
Description copied from class:IoBufferFills this buffer with the specified value. This method moves buffer position forward. -
fillAndReset
Description copied from class:IoBufferFills this buffer with the specified value. This method does not change buffer position.- Specified by:
fillAndResetin classIoBuffer
-
fill
Description copied from class:IoBufferFills this buffer withNUL (0x00). This method moves buffer position forward. -
fillAndReset
Description copied from class:IoBufferFills this buffer withNUL (0x00). This method does not change buffer position.- Specified by:
fillAndResetin classIoBuffer
-
isAutoExpand
public boolean isAutoExpand()Description copied from class:IoBufferReturns true if and only if autoExpand is turned on.- Specified by:
isAutoExpandin classIoBuffer
-
setAutoExpand
Description copied from class:IoBufferTurns on or off autoExpand.- Specified by:
setAutoExpandin classIoBuffer
-
expand
Description copied from class:IoBufferChanges 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. -
expand
Description copied from class:IoBufferChanges 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. -
getObject
Description copied from class:IoBufferReads a Java object from the buffer using the contextClassLoaderof the current thread.- Specified by:
getObjectin classIoBuffer- Throws:
ClassNotFoundException
-
getObject
Description copied from class:IoBufferReads a Java object from the buffer using the specified classLoader.- Specified by:
getObjectin classIoBuffer- Throws:
ClassNotFoundException
-
putObject
Description copied from class:IoBufferWrites the specified Java object to the buffer. -
asInputStream
Description copied from class:IoBufferReturns anInputStreamthat reads the data from this buffer.InputStream.read()returns -1 if the buffer position reaches to the limit.- Specified by:
asInputStreamin classIoBuffer
-
asOutputStream
Description copied from class:IoBufferReturns anOutputStreamthat appends the data into this buffer. Please note that theOutputStream.write(int)will throw aBufferOverflowExceptioninstead of anIOExceptionin case of buffer overflow. Please set autoExpand property by callingIoBuffer.setAutoExpand(boolean)to prevent the unexpected runtime exception.- Specified by:
asOutputStreamin classIoBuffer
-
duplicate
-
slice
-
asReadOnlyBuffer
- Specified by:
asReadOnlyBufferin classIoBuffer- See Also:
-
array
public byte[] array() -
arrayOffset
public int arrayOffset()- Specified by:
arrayOffsetin classIoBuffer- See Also:
-
minimumCapacity
public int minimumCapacity()Description copied from class:IoBufferReturns the minimum capacity of this buffer which is used to determine the new capacity of the buffer shrunk byIoBuffer.compact()andIoBuffer.shrink()operation. The default value is the initial capacity of the buffer.- Specified by:
minimumCapacityin classIoBuffer
-
minimumCapacity
Description copied from class:IoBufferSets the minimum capacity of this buffer which is used to determine the new capacity of the buffer shrunk byIoBuffer.compact()andIoBuffer.shrink()operation. The default value is the initial capacity of the buffer.- Specified by:
minimumCapacityin classIoBuffer
-
capacity
Description copied from class:IoBufferIncreases 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. -
isReadOnly
public boolean isReadOnly()- Specified by:
isReadOnlyin classIoBuffer- See Also:
-
markValue
public int markValue()Description copied from class:IoBufferReturns the position of the current mark. This method returns -1 if no mark is set. -
hasArray
public boolean hasArray() -
free
public void free()Description copied from class:IoBufferDeclares this buffer and all its derived buffers are not used anymore so that it can be reused by someIoBufferAllocatorimplementations. It is not mandatory to call this method, but you might want to invoke this method for maximum performance. -
isDerived
public boolean isDerived()Description copied from class:IoBufferreturns true if and only if this buffer is derived from other buffer viaIoBuffer.duplicate(),IoBuffer.slice()orIoBuffer.asReadOnlyBuffer(). -
isAutoShrink
public boolean isAutoShrink()Description copied from class:IoBufferReturns true if and only if autoShrink is turned on.- Specified by:
isAutoShrinkin classIoBuffer
-
setAutoShrink
Description copied from class:IoBufferTurns on or off autoShrink.- Specified by:
setAutoShrinkin classIoBuffer
-
shrink
Description copied from class:IoBufferChanges 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 thanIoBuffer.minimumCapacity(). The mark is discarded once the capacity changes. -
getMediumInt
public int getMediumInt()Description copied from class:IoBufferRelative 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:
getMediumIntin classIoBuffer- Returns:
- The medium int value at the buffer's current position
-
getUnsignedMediumInt
public int getUnsignedMediumInt()Description copied from class:IoBufferRelative 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:
getUnsignedMediumIntin classIoBuffer- Returns:
- The unsigned medium int value at the buffer's current position
-
getMediumInt
public int getMediumInt(int index) Description copied from class:IoBufferAbsolute 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:
getMediumIntin classIoBuffer- 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) Description copied from class:IoBufferAbsolute 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:
getUnsignedMediumIntin classIoBuffer- Parameters:
index- The index from which the unsigned medium int will be read- Returns:
- The unsigned medium int value at the given index
-
putMediumInt
Description copied from class:IoBufferRelative 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:
putMediumIntin classIoBuffer- Parameters:
value- The medium int value to be written- Returns:
- This buffer
-
putMediumInt
Description copied from class:IoBufferAbsolute 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:
putMediumIntin classIoBuffer- Parameters:
index- The index at which the bytes will be writtenvalue- The medium int value to be written- Returns:
- This buffer
-
getHexDump
Description copied from class:IoBufferReturn hexdump of this buffer with limited length.- Specified by:
getHexDumpin classIoBuffer- Parameters:
lengthLimit- The maximum number of bytes to dump from the current buffer position.- Returns:
- hexidecimal representation of this buffer
-
prefixedDataAvailable
public boolean prefixedDataAvailable(int prefixLength) Description copied from class:IoBufferReturns 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 useIoBuffer.prefixedDataAvailable(int, int)instead.- Specified by:
prefixedDataAvailablein classIoBuffer- Parameters:
prefixLength- the length of the prefix field (1, 2, or 4)
-
prefixedDataAvailable
public boolean prefixedDataAvailable(int prefixLength, int maxDataLength) Description copied from class:IoBufferReturns 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:
prefixedDataAvailablein classIoBuffer- 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) Description copied from class:IoBufferReturns the first occurence position of the specified byte from the current position to the current limit. -
getEnum
Description copied from class:IoBufferReads a byte from the buffer and returns the correlating enum constant defined by the specified enum type. -
getEnum
Description copied from class:IoBufferReads a byte from the buffer and returns the correlating enum constant defined by the specified enum type. -
getEnumShort
Description copied from class:IoBufferReads a short from the buffer and returns the correlating enum constant defined by the specified enum type.- Specified by:
getEnumShortin classIoBuffer- Type Parameters:
E- The enum type to return- Parameters:
enumClass- The enum's class object
-
getEnumShort
Description copied from class:IoBufferReads a short from the buffer and returns the correlating enum constant defined by the specified enum type.- Specified by:
getEnumShortin classIoBuffer- Type Parameters:
E- The enum type to return- Parameters:
index- the index from which the bytes will be readenumClass- The enum's class object
-
getEnumInt
Description copied from class:IoBufferReads an int from the buffer and returns the correlating enum constant defined by the specified enum type.- Specified by:
getEnumIntin classIoBuffer- Type Parameters:
E- The enum type to return- Parameters:
enumClass- The enum's class object
-
getEnumInt
Description copied from class:IoBufferReads an int from the buffer and returns the correlating enum constant defined by the specified enum type.- Specified by:
getEnumIntin classIoBuffer- Type Parameters:
E- The enum type to return- Parameters:
index- the index from which the bytes will be readenumClass- The enum's class object
-
putEnum
Description copied from class:IoBufferWrites an enum's ordinal value to the buffer as a byte. -
putEnum
Description copied from class:IoBufferWrites an enum's ordinal value to the buffer as a byte. -
putEnumShort
Description copied from class:IoBufferWrites an enum's ordinal value to the buffer as a short.- Specified by:
putEnumShortin classIoBuffer- Parameters:
e- The enum to write to the buffer
-
putEnumShort
Description copied from class:IoBufferWrites an enum's ordinal value to the buffer as a short.- Specified by:
putEnumShortin classIoBuffer- Parameters:
index- The index at which the bytes will be writtene- The enum to write to the buffer
-
putEnumInt
Description copied from class:IoBufferWrites an enum's ordinal value to the buffer as an integer.- Specified by:
putEnumIntin classIoBuffer- Parameters:
e- The enum to write to the buffer
-
putEnumInt
Description copied from class:IoBufferWrites an enum's ordinal value to the buffer as an integer.- Specified by:
putEnumIntin classIoBuffer- Parameters:
index- The index at which the bytes will be writtene- The enum to write to the buffer
-
getEnumSet
Description copied from class:IoBufferReads a byte sized bit vector and converts it to anEnumSet.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:
getEnumSetin classIoBuffer- 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
Description copied from class:IoBufferReads a byte sized bit vector and converts it to anEnumSet.- Specified by:
getEnumSetin classIoBuffer- Type Parameters:
E- the enum type- Parameters:
index- the index from which the byte will be readenumClass- the enum class used to create the EnumSet- Returns:
- the EnumSet representation of the bit vector
- See Also:
-
getEnumSetShort
Description copied from class:IoBufferReads a short sized bit vector and converts it to anEnumSet.- Specified by:
getEnumSetShortin classIoBuffer- 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
Description copied from class:IoBufferReads a short sized bit vector and converts it to anEnumSet.- Specified by:
getEnumSetShortin classIoBuffer- Type Parameters:
E- the enum type- Parameters:
index- the index from which the bytes will be readenumClass- the enum class used to create the EnumSet- Returns:
- the EnumSet representation of the bit vector
- See Also:
-
getEnumSetInt
Description copied from class:IoBufferReads an int sized bit vector and converts it to anEnumSet.- Specified by:
getEnumSetIntin classIoBuffer- 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
Description copied from class:IoBufferReads an int sized bit vector and converts it to anEnumSet.- Specified by:
getEnumSetIntin classIoBuffer- Type Parameters:
E- the enum type- Parameters:
index- the index from which the bytes will be readenumClass- the enum class used to create the EnumSet- Returns:
- the EnumSet representation of the bit vector
- See Also:
-
getEnumSetLong
Description copied from class:IoBufferReads a long sized bit vector and converts it to anEnumSet.- Specified by:
getEnumSetLongin classIoBuffer- 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
Description copied from class:IoBufferReads a long sized bit vector and converts it to anEnumSet.- Specified by:
getEnumSetLongin classIoBuffer- Type Parameters:
E- the enum type- Parameters:
index- the index from which the bytes will be readenumClass- the enum class used to create the EnumSet- Returns:
- the EnumSet representation of the bit vector
- See Also:
-
putEnumSet
Description copied from class:IoBufferWrites the specifiedSetto the buffer as a byte sized bit vector.- Specified by:
putEnumSetin classIoBuffer- Type Parameters:
E- the enum type of the Set- Parameters:
set- the enum set to write to the buffer
-
putEnumSet
Description copied from class:IoBufferWrites the specifiedSetto the buffer as a byte sized bit vector.- Specified by:
putEnumSetin classIoBuffer- Type Parameters:
E- the enum type of the Set- Parameters:
index- the index at which the byte will be writtenset- the enum set to write to the buffer
-
putEnumSetShort
Description copied from class:IoBufferWrites the specifiedSetto the buffer as a short sized bit vector.- Specified by:
putEnumSetShortin classIoBuffer- Type Parameters:
E- the enum type of the Set- Parameters:
set- the enum set to write to the buffer
-
putEnumSetShort
Description copied from class:IoBufferWrites the specifiedSetto the buffer as a short sized bit vector.- Specified by:
putEnumSetShortin classIoBuffer- Type Parameters:
E- the enum type of the Set- Parameters:
index- the index at which the bytes will be writtenset- the enum set to write to the buffer
-
putEnumSetInt
Description copied from class:IoBufferWrites the specifiedSetto the buffer as an int sized bit vector.- Specified by:
putEnumSetIntin classIoBuffer- Type Parameters:
E- the enum type of the Set- Parameters:
set- the enum set to write to the buffer
-
putEnumSetInt
Description copied from class:IoBufferWrites the specifiedSetto the buffer as an int sized bit vector.- Specified by:
putEnumSetIntin classIoBuffer- Type Parameters:
E- the enum type of the Set- Parameters:
index- the index at which the bytes will be writtenset- the enum set to write to the buffer
-
putEnumSetLong
Description copied from class:IoBufferWrites the specifiedSetto the buffer as a long sized bit vector.- Specified by:
putEnumSetLongin classIoBuffer- Type Parameters:
E- the enum type of the Set- Parameters:
set- the enum set to write to the buffer
-
putEnumSetLong
Description copied from class:IoBufferWrites the specifiedSetto the buffer as a long sized bit vector.- Specified by:
putEnumSetLongin classIoBuffer- Type Parameters:
E- the enum type of the Set- Parameters:
index- the index at which the bytes will be writtenset- the enum set to write to the buffer
-