Undertow 2.3.12.Final · io.undertow.util.HttpString · APIdia, the JavaDoc alternative

Modifier and Type	Field and Description
private final byte[]	bytes
public static final HttpString	EMPTY Empty HttpString instance.
private final transient int	hashCode
private static final Field	hashCodeField
private final int	orderInt And integer that is only set for well known header to make comparison fast
private static final long	serialVersionUID
private transient String	string

Access	Constructor and Description
public	HttpString(final byte[] the byte array to copy bytes) Construct a new instance.
public	HttpString(final byte[] the byte array to copy bytes, int the offset into the array to start copying offset, int the number of bytes to copy length) Construct a new instance.
public	HttpString(final ByteBuffer the buffer to read buffer) Construct a new instance by reading the remaining bytes from a buffer.
public	HttpString(final String the source string string) Construct a new instance from a `String`.
pack-priv	HttpString(final String string, int orderInt)
private	HttpString(final byte[] bytes, final String string)

Method Summary

Modifier and Type	Method and Description
public void	appendTo(ByteBuffer the buffer to append to buffer) Append to a byte buffer.
public byte	Returns: the byte at an index byteAt(int idx) Get the byte at an index.
private static boolean	bytesAreEqual(final byte[] a, final byte[] b)
private static boolean	bytesAreEquivalent(final byte[] a, final byte[] b)
private static int	calcHashCode(final byte[] bytes)
private void	checkForNewlines()
public int	Returns: -1, 0, or 1 compareTo(final HttpString the other string other) Implements java.lang.Comparable.compareTo. Compare this string to another in a case-insensitive manner.
public void	copyTo(int the source offset srcOffs, byte[] the destination dst, int the destination offset offs, int the number of bytes to copy len) Copy `len` bytes from this string at offset `srcOffs` to the given array at the given offset.
public void	copyTo(byte[] the destination dst, int the destination offset offs, int the number of bytes len) Copy `len` bytes from this string to the given array at the given offset.
public void	copyTo(byte[] the destination dst, int the destination offset offs) Copy all the bytes from this string to the given array at the given offset.
public boolean	Returns: `true` if they are equal, `false` otherwise equals(final Object the other object other) Overrides java.lang.Object.equals. Determine if this `HttpString` is equal to another.
public boolean	Returns: `true` if they are equal, `false` otherwise equals(final HttpString the other object other) Determine if this `HttpString` is equal to another.
public boolean	equalToString(String headerName)
public int	Returns: the hash code hashCode() Overrides java.lang.Object.hashCode. Get the hash code.
pack-priv static int	hashCodeOf(final String headerName)
private static int	higher(byte b)
public int	Returns: the string length length() Get the string length.
private void	readObject(ObjectInputStream ois)
private static byte[]	take(final ByteBuffer buffer)
private static byte[]	toByteArray(final String string)
public String	Returns: the string toString() Overrides java.lang.Object.toString. Get the `String` representation of this `HttpString`.
public static HttpString	Returns: the HTTP string, or `null` if the string is not in a compatible encoding tryFromString(String the string to try string) Attempt to convert a `String` to an `HttpString`.
public void	writeTo(OutputStream the stream to write to output) Append to an output stream.

Inherited from java.lang.Object:: clone finalize getClass notify notifyAll wait wait wait

Field Detail

bytes	back to summary
private final byte[] bytes

EMPTY	back to summary
public static final HttpString EMPTY Empty HttpString instance.

hashCode	back to summary
private final transient int hashCode

hashCodeField	back to summary
private static final Field hashCodeField

orderInt	back to summary
private final int orderInt And integer that is only set for well known header to make comparison fast

serialVersionUID	back to summary
private static final long serialVersionUID

string	back to summary
private transient String string

Constructor Detail

HttpString	back to summary
public HttpString(final byte[] bytes) Construct a new instance. Parameters bytes:byte[] the byte array to copy

HttpString

back to summary

public HttpString(final byte[] bytes)

Construct a new instance.

Parameters

bytes:byte[]: the byte array to copy

HttpString	back to summary
public HttpString(final byte[] bytes, int offset, int length) Construct a new instance. Parameters bytes:byte[] the byte array to copy offset:int the offset into the array to start copying length:int the number of bytes to copy

HttpString

back to summary

public HttpString(final byte[] bytes, int offset, int length)

Construct a new instance.

Parameters

bytes:byte[]: the byte array to copy
offset:int: the offset into the array to start copying
length:int: the number of bytes to copy

HttpString	back to summary
public HttpString(final ByteBuffer buffer) Construct a new instance by reading the remaining bytes from a buffer. Parameters buffer:ByteBuffer the buffer to read

HttpString

back to summary

public HttpString(final ByteBuffer buffer)

Construct a new instance by reading the remaining bytes from a buffer.

Parameters

buffer:ByteBuffer: the buffer to read

HttpString back to summary

HttpString	back to summary
public HttpString(final String string) Construct a new instance from a `String`. The `String` will be used as the cached `toString()` value for this `HttpString`. Parameters string:String the source string

public HttpString(final String string)

Construct a new instance from a String. The String will be used as the cached toString() value for this HttpString.

Parameters

string:String: the source string

HttpString	back to summary
pack-priv HttpString(final String string, int orderInt)

HttpString	back to summary
private HttpString(final byte[] bytes, final String string)

Method Detail

appendTo	back to summary
public void appendTo(ByteBuffer buffer) Append to a byte buffer. Parameters buffer:ByteBuffer the buffer to append to

appendTo

back to summary

public void appendTo(ByteBuffer buffer)

Append to a byte buffer.

Parameters

buffer:ByteBuffer: the buffer to append to

byteAt	back to summary
public byte byteAt(int idx) Get the byte at an index. Returns:byte the byte at an index

byteAt

back to summary

public byte byteAt(int idx)

Get the byte at an index.

Returns:byte: the byte at an index

bytesAreEqual	back to summary
private static boolean bytesAreEqual(final byte[] a, final byte[] b)

bytesAreEquivalent	back to summary
private static boolean bytesAreEquivalent(final byte[] a, final byte[] b)

calcHashCode	back to summary
private static int calcHashCode(final byte[] bytes)

checkForNewlines	back to summary
private void checkForNewlines()

compareTo	back to summary
public int compareTo(final HttpString other) Implements java.lang.Comparable.compareTo. Compare this string to another in a case-insensitive manner. Parameters other:HttpString the other string Returns:int -1, 0, or 1

compareTo

back to summary

public int compareTo(final HttpString other)

Implements java.lang.Comparable.compareTo.

Compare this string to another in a case-insensitive manner.

Parameters

other:HttpString: the other string

Returns:int

-1, 0, or 1

copyTo back to summary

copyTo	back to summary
public void copyTo(int srcOffs, byte[] dst, int offs, int len) Copy `len` bytes from this string at offset `srcOffs` to the given array at the given offset. Parameters srcOffs:int the source offset dst:byte[] the destination offs:int the destination offset len:int the number of bytes to copy

public void copyTo(int srcOffs, byte[] dst, int offs, int len)

Copy len bytes from this string at offset srcOffs to the given array at the given offset.

Parameters

srcOffs:int: the source offset
dst:byte[]: the destination
offs:int: the destination offset
len:int: the number of bytes to copy

copyTo back to summary

copyTo	back to summary
public void copyTo(byte[] dst, int offs, int len) Copy `len` bytes from this string to the given array at the given offset. Parameters dst:byte[] the destination offs:int the destination offset len:int the number of bytes

public void copyTo(byte[] dst, int offs, int len)

Copy len bytes from this string to the given array at the given offset.

Parameters

dst:byte[]: the destination
offs:int: the destination offset
len:int: the number of bytes

copyTo	back to summary
public void copyTo(byte[] dst, int offs) Copy all the bytes from this string to the given array at the given offset. Parameters dst:byte[] the destination offs:int the destination offset

copyTo

back to summary

public void copyTo(byte[] dst, int offs)

Copy all the bytes from this string to the given array at the given offset.

Parameters

dst:byte[]: the destination
offs:int: the destination offset

equals back to summary

equals	back to summary
public boolean equals(final Object other) Overrides java.lang.Object.equals. Determine if this `HttpString` is equal to another. Parameters other:Object the other object Returns:boolean `true` if they are equal, `false` otherwise Annotations @Override

public boolean equals(final Object other)

Overrides java.lang.Object.equals.

Determine if this HttpString is equal to another.

Parameters

other:Object: the other object

Returns:boolean

true if they are equal, false otherwise

Annotations

@Override

equals back to summary

equals	back to summary
public boolean equals(final HttpString other) Determine if this `HttpString` is equal to another. Parameters other:HttpString the other object Returns:boolean `true` if they are equal, `false` otherwise

public boolean equals(final HttpString other)

Determine if this HttpString is equal to another.

Parameters

other:HttpString: the other object

Returns:boolean

true if they are equal, false otherwise

equalToString	back to summary
public boolean equalToString(String headerName)

hashCode	back to summary
public int hashCode() Overrides java.lang.Object.hashCode. Get the hash code. Returns:int the hash code Annotations @Override

hashCode

back to summary

public int hashCode()

Overrides java.lang.Object.hashCode.

Get the hash code.

Returns:int

the hash code

Annotations

@Override

hashCodeOf	back to summary
pack-priv static int hashCodeOf(final String headerName)

higher	back to summary
private static int higher(byte b)

length	back to summary
public int length() Get the string length. Returns:int the string length

length

back to summary

public int length()

Get the string length.

Returns:int: the string length

readObject	back to summary
private void readObject(ObjectInputStream ois) throws ClassNotFoundException, IOException

take	back to summary
private static byte[] take(final ByteBuffer buffer)

toByteArray	back to summary
private static byte[] toByteArray(final String string)

toString back to summary

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Get the `String` representation of this `HttpString`. Returns:String the string Annotations @Override

public String toString()

Overrides java.lang.Object.toString.

Get the String representation of this HttpString.

Returns:String

the string

Annotations

@Override

tryFromString back to summary

tryFromString	back to summary
public static HttpString tryFromString(String string) Attempt to convert a `String` to an `HttpString`. If the string cannot be converted, `null` is returned. Parameters string:String the string to try Returns:HttpString the HTTP string, or `null` if the string is not in a compatible encoding

public static HttpString tryFromString(String string)

Attempt to convert a String to an HttpString. If the string cannot be converted, null is returned.

Parameters

string:String: the string to try

Returns:HttpString

the HTTP string, or null if the string is not in a compatible encoding

writeTo	back to summary
public void writeTo(OutputStream output) throws IOException Append to an output stream. Parameters output:OutputStream the stream to write to Exceptions IOException: if an error occurs

writeTo

back to summary

public void writeTo(OutputStream output) throws IOException

Append to an output stream.

Parameters

output:OutputStream: the stream to write to

Exceptions

IOException:: if an error occurs

public final Class HttpString

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail