Class ByteChunk
- java.lang.Object
-
- org.apache.tomcat.util.buf.AbstractChunk
-
- org.apache.tomcat.util.buf.ByteChunk
-
- All Implemented Interfaces:
java.io.Serializable,java.lang.Cloneable
public final class ByteChunk extends AbstractChunk
This class is used to represent a chunk of bytes, and utilities to manipulate byte[].The buffer can be modified and used for both input and output.
There are 2 modes: The chunk can be associated with a sink - ByteInputChannel or ByteOutputChannel, which will be used when the buffer is empty (on input) or filled (on output). For output, it can also grow. This operating mode is selected by calling setLimit() or allocate(initial, limit) with limit != -1.
Various search and append method are defined - similar with String and StringBuffer, but operating on bytes.
This is important because it allows processing the http headers directly on the received bytes, without converting to chars and Strings until the strings are needed. In addition, the charset is determined later, from headers or user code.
- Author:
- dac@sun.com, James Todd [gonzo@sun.com], Costin Manolache, Remy Maucherat
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classByteChunk.BufferOverflowExceptionstatic interfaceByteChunk.ByteInputChannelInput interface, used when the buffer is empty.static interfaceByteChunk.ByteOutputChannelWhen we need more space we'll either grow the buffer ( up to the limit ) or send it to a channel.
-
Field Summary
Fields Modifier and Type Field Description static java.nio.charset.CharsetDEFAULT_CHARSETDefault encoding used to convert to strings.-
Fields inherited from class org.apache.tomcat.util.buf.AbstractChunk
ARRAY_MAX_SIZE, end, hasHashCode, isSet, sm, start
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description voidallocate(int initial, int limit)voidappend(byte b)voidappend(byte[] src, int off, int len)Add data to the buffer.voidappend(java.nio.ByteBuffer from)Add data to the buffer.voidappend(ByteChunk src)java.lang.Objectclone()static byte[]convertToBytes(java.lang.String value)Convert specified String to a byte array.booleanequals(byte[] b2, int off2, int len2)booleanequals(char[] c2, int off2, int len2)booleanequals(java.lang.Object obj)booleanequals(java.lang.String s)Compares the message bytes to the specified String object.booleanequals(ByteChunk bb)booleanequals(CharChunk cc)booleanequalsIgnoreCase(java.lang.String s)Compares the message bytes to the specified String object.static intfindByte(byte[] bytes, int start, int end, byte b)Returns the first instance of the given byte in the byte array between the specified start and end.static intfindBytes(byte[] bytes, int start, int end, byte[] b)Returns the first instance of any of the given bytes in the byte array between the specified start and end.voidflushBuffer()Send the buffer to the sink.byte[]getBuffer()protected intgetBufferElement(int index)byte[]getBytes()java.nio.charset.CharsetgetCharset()longgetLong()static intindexOf(byte[] bytes, int start, int end, char s)Returns the first instance of the given character in the given byte array between the specified start and end.intindexOf(char c, int starting)Returns the first instance of the given character in this ByteChunk starting at the specified byte.voidmakeSpace(int count)Make space for len bytes.voidrecycle()Resets the chunk to an uninitialized state.voidsetByteInputChannel(ByteChunk.ByteInputChannel in)When the buffer is empty, read the data from the input channel.voidsetByteOutputChannel(ByteChunk.ByteOutputChannel out)When the buffer is full, write the data to the output channel.voidsetBytes(byte[] b, int off, int len)Sets the buffer to the specified subarray of bytes.voidsetCharset(java.nio.charset.Charset charset)booleanstartsWith(java.lang.String s, int pos)Returns true if the buffer starts with the specified string when tested in a case sensitive manner.booleanstartsWithIgnoreCase(java.lang.String s, int pos)Returns true if the buffer starts with the specified string when tested in a case insensitive manner.intsubstract()Deprecated.intsubstract(byte[] dest, int off, int len)Deprecated.intsubstract(java.nio.ByteBuffer to)Deprecated.Usesubtract(ByteBuffer).bytesubstractB()Deprecated.intsubtract()intsubtract(byte[] dest, int off, int len)intsubtract(java.nio.ByteBuffer to)Transfers bytes from the buffer to the specified ByteBuffer.bytesubtractB()java.lang.StringtoString()java.lang.StringtoString(java.nio.charset.CodingErrorAction malformedInputAction, java.nio.charset.CodingErrorAction unmappableCharacterAction)java.lang.StringtoStringInternal()Deprecated.Unused.java.lang.StringtoStringInternal(java.nio.charset.CodingErrorAction malformedInputAction, java.nio.charset.CodingErrorAction unmappableCharacterAction)Converts the current content of the byte buffer to a String using the configured character set.
-
-
-
Method Detail
-
clone
public java.lang.Object clone() throws java.lang.CloneNotSupportedException- Overrides:
clonein classjava.lang.Object- Throws:
java.lang.CloneNotSupportedException
-
recycle
public void recycle()
Description copied from class:AbstractChunkResets the chunk to an uninitialized state.- Overrides:
recyclein classAbstractChunk
-
allocate
public void allocate(int initial, int limit)
-
setBytes
public void setBytes(byte[] b, int off, int len)Sets the buffer to the specified subarray of bytes.- Parameters:
b- the ascii bytesoff- the start offset of the byteslen- the length of the bytes
-
setCharset
public void setCharset(java.nio.charset.Charset charset)
-
getCharset
public java.nio.charset.Charset getCharset()
-
getBytes
public byte[] getBytes()
- Returns:
- the buffer.
-
getBuffer
public byte[] getBuffer()
- Returns:
- the buffer.
-
setByteInputChannel
public void setByteInputChannel(ByteChunk.ByteInputChannel in)
When the buffer is empty, read the data from the input channel.- Parameters:
in- The input channel
-
setByteOutputChannel
public void setByteOutputChannel(ByteChunk.ByteOutputChannel out)
When the buffer is full, write the data to the output channel. Also used when large amount of data is appended. If not set, the buffer will grow to the limit.- Parameters:
out- The output channel
-
append
public void append(byte b) throws java.io.IOException- Throws:
java.io.IOException
-
append
public void append(ByteChunk src) throws java.io.IOException
- Throws:
java.io.IOException
-
append
public void append(byte[] src, int off, int len) throws java.io.IOExceptionAdd data to the buffer.- Parameters:
src- Bytes arrayoff- Offsetlen- Length- Throws:
java.io.IOException- Writing overflow data to the output channel failed
-
append
public void append(java.nio.ByteBuffer from) throws java.io.IOExceptionAdd data to the buffer.- Parameters:
from- the ByteBuffer with the data- Throws:
java.io.IOException- Writing overflow data to the output channel failed
-
substract
@Deprecated public int substract() throws java.io.IOExceptionDeprecated.- Throws:
java.io.IOException
-
subtract
public int subtract() throws java.io.IOException- Throws:
java.io.IOException
-
substractB
@Deprecated public byte substractB() throws java.io.IOExceptionDeprecated.- Throws:
java.io.IOException
-
subtractB
public byte subtractB() throws java.io.IOException- Throws:
java.io.IOException
-
substract
@Deprecated public int substract(byte[] dest, int off, int len) throws java.io.IOExceptionDeprecated.- Throws:
java.io.IOException
-
subtract
public int subtract(byte[] dest, int off, int len) throws java.io.IOException- Throws:
java.io.IOException
-
substract
@Deprecated public int substract(java.nio.ByteBuffer to) throws java.io.IOExceptionDeprecated.Usesubtract(ByteBuffer). This method will be removed in Tomcat 10Transfers bytes from the buffer to the specified ByteBuffer. After the operation the position of the ByteBuffer will be returned to the one before the operation, the limit will be the position incremented by the number of the transferred bytes.- Parameters:
to- the ByteBuffer into which bytes are to be written.- Returns:
- an integer specifying the actual number of bytes read, or -1 if the end of the stream is reached
- Throws:
java.io.IOException- if an input or output exception has occurred
-
subtract
public int subtract(java.nio.ByteBuffer to) throws java.io.IOExceptionTransfers bytes from the buffer to the specified ByteBuffer. After the operation the position of the ByteBuffer will be returned to the one before the operation, the limit will be the position incremented by the number of the transfered bytes.- Parameters:
to- the ByteBuffer into which bytes are to be written.- Returns:
- an integer specifying the actual number of bytes read, or -1 if the end of the stream is reached
- Throws:
java.io.IOException- if an input or output exception has occurred
-
flushBuffer
public void flushBuffer() throws java.io.IOExceptionSend the buffer to the sink. Called by append() when the limit is reached. You can also call it explicitly to force the data to be written.- Throws:
java.io.IOException- Writing overflow data to the output channel failed
-
makeSpace
public void makeSpace(int count)
Make space for len bytes. If len is small, allocate a reserve space too. Never grow bigger than the limit orAbstractChunk.ARRAY_MAX_SIZE.- Parameters:
count- The size
-
toString
public java.lang.String toString()
- Overrides:
toStringin classjava.lang.Object
-
toString
public java.lang.String toString(java.nio.charset.CodingErrorAction malformedInputAction, java.nio.charset.CodingErrorAction unmappableCharacterAction) throws java.nio.charset.CharacterCodingException- Throws:
java.nio.charset.CharacterCodingException
-
toStringInternal
@Deprecated public java.lang.String toStringInternal()
Deprecated.Unused. This method will be removed in Tomcat 11 onwards.Converts the current content of the byte buffer to a String using the configured character set.- Returns:
- The result of converting the bytes to a String
-
toStringInternal
public java.lang.String toStringInternal(java.nio.charset.CodingErrorAction malformedInputAction, java.nio.charset.CodingErrorAction unmappableCharacterAction) throws java.nio.charset.CharacterCodingExceptionConverts the current content of the byte buffer to a String using the configured character set.- Parameters:
malformedInputAction- Action to take if the input is malformedunmappableCharacterAction- Action to take if a byte sequence can't be mapped to a character- Returns:
- The result of converting the bytes to a String
- Throws:
java.nio.charset.CharacterCodingException- If an error occurs during the conversion
-
getLong
public long getLong()
-
equals
public boolean equals(java.lang.Object obj)
- Overrides:
equalsin classjava.lang.Object
-
equals
public boolean equals(java.lang.String s)
Compares the message bytes to the specified String object.- Parameters:
s- the String to compare- Returns:
trueif the comparison succeeded,falseotherwise
-
equalsIgnoreCase
public boolean equalsIgnoreCase(java.lang.String s)
Compares the message bytes to the specified String object.- Parameters:
s- the String to compare- Returns:
trueif the comparison succeeded,falseotherwise
-
equals
public boolean equals(ByteChunk bb)
-
equals
public boolean equals(byte[] b2, int off2, int len2)
-
equals
public boolean equals(CharChunk cc)
-
equals
public boolean equals(char[] c2, int off2, int len2)
-
startsWith
public boolean startsWith(java.lang.String s, int pos)Returns true if the buffer starts with the specified string when tested in a case sensitive manner.- Parameters:
s- the stringpos- The position- Returns:
trueif the start matches
-
startsWithIgnoreCase
public boolean startsWithIgnoreCase(java.lang.String s, int pos)Returns true if the buffer starts with the specified string when tested in a case insensitive manner.- Parameters:
s- the stringpos- The position- Returns:
trueif the start matches
-
getBufferElement
protected int getBufferElement(int index)
- Specified by:
getBufferElementin classAbstractChunk
-
indexOf
public int indexOf(char c, int starting)Returns the first instance of the given character in this ByteChunk starting at the specified byte. If the character is not found, -1 is returned.NOTE: This only works for characters in the range 0-127.
- Parameters:
c- The characterstarting- The start position- Returns:
- The position of the first instance of the character or -1 if the character is not found.
-
indexOf
public static int indexOf(byte[] bytes, int start, int end, char s)Returns the first instance of the given character in the given byte array between the specified start and end.NOTE: This only works for characters in the range 0-127.
- Parameters:
bytes- The array to searchstart- The point to start searching from in the arrayend- The point to stop searching in the arrays- The character to search for- Returns:
- The position of the first instance of the character or -1 if the character is not found.
-
findByte
public static int findByte(byte[] bytes, int start, int end, byte b)Returns the first instance of the given byte in the byte array between the specified start and end.- Parameters:
bytes- The byte array to searchstart- The point to start searching from in the byte arrayend- The point to stop searching in the byte arrayb- The byte to search for- Returns:
- The position of the first instance of the byte or -1 if the byte is not found.
-
findBytes
public static int findBytes(byte[] bytes, int start, int end, byte[] b)Returns the first instance of any of the given bytes in the byte array between the specified start and end.- Parameters:
bytes- The byte array to searchstart- The point to start searching from in the byte arrayend- The point to stop searching in the byte arrayb- The array of bytes to search for- Returns:
- The position of the first instance of the byte or -1 if the byte is not found.
-
convertToBytes
public static byte[] convertToBytes(java.lang.String value)
Convert specified String to a byte array. This ONLY WORKS for ascii, UTF chars will be truncated.- Parameters:
value- to convert to byte array- Returns:
- the byte array value
-
-