io.netty.util

Class AsciiString

java.lang.Object

io.netty.util.ByteString

io.netty.util.AsciiString

All Implemented Interfaces:

CharSequence, Comparable<CharSequence>

public final class AsciiString
extends ByteString
implements CharSequence, Comparable<CharSequence>

A string which has been encoded into a character encoding whose character always takes a single byte, similarly to ASCII. It internally keeps its content in a byte array unlike String, which uses a character array, for reduced memory footprint and faster data transfer from/to byte-based data structures such as a byte array and ByteBuffer. It is often used in conjunction with TextHeaders.

Nested Class Summary

Nested classes/interfaces inherited from class io.netty.util.ByteString

ByteString.ByteStringFactory

Field Summary

Fields

Modifier and Type	Field and Description
static HashingStrategy<CharSequence>	CASE_INSENSITIVE_HASHER
static HashingStrategy<CharSequence>	CASE_SENSITIVE_HASHER
static AsciiString	EMPTY_STRING

Fields inherited from class io.netty.util.ByteString

HASH_CODE_PRIME, value

Constructor Summary

Constructors

Constructor and Description
AsciiString(byte[] value)
AsciiString(byte[] value, boolean copy)
AsciiString(byte[] value, int start, int length, boolean copy)
AsciiString(ByteBuffer value)
AsciiString(ByteBuffer value, int start, int length, boolean copy)
AsciiString(ByteString value, boolean copy)
AsciiString(char[] value)
AsciiString(char[] value, int start, int length)
AsciiString(CharSequence value)
AsciiString(CharSequence value, int start, int length)

Method Summary

Methods

Modifier and Type	Method and Description
void	arrayChanged() During normal use cases the ByteString should be immutable, but if the underlying array is shared, and changes then this needs to be called.
static int	caseInsensitiveHashCode(CharSequence value) Returns the case-insensitive hash code of the specified string.
char	charAt(int index)
int	compareTo(CharSequence string) Compares the specified string to this string using the ASCII values of the characters.
AsciiString	concat(CharSequence string) Concatenates this string and the specified string.
boolean	contains(CharSequence cs) Determines if this String contains the sequence of characters in the CharSequence passed.
boolean	contentEquals(CharSequence a) Compares a CharSequence to this String to determine if their contents are equal.
static boolean	contentEquals(CharSequence a, CharSequence b) Returns true if the content of both CharSequence's are equals.
boolean	contentEqualsIgnoreCase(CharSequence string) Compares the specified string to this string ignoring the case of the characters and returns true if they are equal.
static boolean	contentEqualsIgnoreCase(CharSequence a, CharSequence b) Returns true if both CharSequence's are equals when ignore the case.
void	copy(int srcIdx, char[] dst, int dstIdx, int length) Copied the content of this string to a character array.
boolean	endsWith(CharSequence suffix) Compares the specified string to this string to determine if the specified string is a suffix.
static int	hashCode(CharSequence value) A case-sensitive version of caseInsensitiveHashCode(CharSequence).
int	hashCodeCaseInsensitive() Generate a hash code that will be consistent regardless of ASCII character casing.
int	indexOf(CharSequence string) Searches in this string for the first index of the specified string.
int	indexOf(CharSequence subString, int start) Searches in this string for the index of the specified string.
int	lastIndexOf(CharSequence string) Searches in this string for the last index of the specified string.
int	lastIndexOf(CharSequence subString, int start) Searches in this string for the index of the specified string.
boolean	matches(String expr) Determines whether this string matches a given regular expression.
static AsciiString	of(CharSequence string) Returns an AsciiString containing the given character sequence.
boolean	regionMatches(boolean ignoreCase, int thisStart, CharSequence string, int start, int length) Compares the specified string to this string and compares the specified range of characters to determine if they are the same.
boolean	regionMatches(int thisStart, CharSequence string, int start, int length) Compares the specified string to this string and compares the specified range of characters to determine if they are the same.
AsciiString	replace(char oldChar, char newChar) Copies this string replacing occurrences of the specified character with another character.
AsciiString[]	split(char delim) Splits the specified String with the specified delimiter..
AsciiString[]	split(String expr, int max) Splits this string using the supplied regular expression expr.
boolean	startsWith(CharSequence prefix) Compares the specified string to this string to determine if the specified string is a prefix.
boolean	startsWith(CharSequence prefix, int start) Compares the specified string to this string, starting at the specified offset, to determine if the specified string is a prefix.
AsciiString	subSequence(int start) Copies a range of characters into a new string.
AsciiString	subSequence(int start, int end) Copies a range of characters into a new string.
AsciiString	subSequence(int start, int end, boolean copy) Either copy or share a subset of underlying sub-sequence of bytes.
char[]	toCharArray() Copies the characters in this string to a character array.
char[]	toCharArray(int start, int end) Copies the characters in this string to a character array.
AsciiString	toLowerCase() Converts the characters in this string to lowercase, using the default Locale.
String	toString(Charset charset, int start, int end) Translates the [start, end) range of this byte string to a String using the charset encoding.
AsciiString	toUpperCase() Converts the characters in this string to uppercase, using the default Locale.
AsciiString	trim() Copies this string removing white space characters from the beginning and end of the string.

Methods inherited from class io.netty.util.ByteString

array, arrayOffset, byteAt, copy, equals, forEachByte, forEachByte, forEachByteDesc, forEachByteDesc, fromAscii, hashCode, isEmpty, isEntireArrayUsed, length, parseAsciiDouble, parseAsciiDouble, parseAsciiFloat, parseAsciiFloat, parseAsciiInt, parseAsciiInt, parseAsciiInt, parseAsciiInt, parseAsciiLong, parseAsciiLong, parseAsciiLong, parseAsciiLong, parseAsciiShort, parseAsciiShort, parseAsciiShort, parseAsciiShort, parseChar, parseChar, subSequence, toByteArray, toByteArray, toString, toString, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.lang.CharSequence

length, toString

Field Detail

EMPTY_STRING

public static final AsciiString EMPTY_STRING

CASE_INSENSITIVE_HASHER

public static final HashingStrategy<CharSequence> CASE_INSENSITIVE_HASHER

CASE_SENSITIVE_HASHER

public static final HashingStrategy<CharSequence> CASE_SENSITIVE_HASHER

Constructor Detail

AsciiString

public AsciiString(byte[] value)

AsciiString

public AsciiString(byte[] value,
           boolean copy)

AsciiString

public AsciiString(byte[] value,
           int start,
           int length,
           boolean copy)

AsciiString

public AsciiString(ByteString value,
           boolean copy)

AsciiString

public AsciiString(ByteBuffer value)

AsciiString

public AsciiString(ByteBuffer value,
           int start,
           int length,
           boolean copy)

AsciiString

public AsciiString(char[] value)

AsciiString

public AsciiString(char[] value,
           int start,
           int length)

AsciiString

public AsciiString(CharSequence value)

AsciiString

public AsciiString(CharSequence value,
           int start,
           int length)

Method Detail

of

public static AsciiString of(CharSequence string)

Returns an AsciiString containing the given character sequence. If the given string is already a AsciiString, just returns the same instance.

charAt

public char charAt(int index)

Specified by:

charAt in interface CharSequence

arrayChanged

public void arrayChanged()

Description copied from class: ByteString

During normal use cases the ByteString should be immutable, but if the underlying array is shared, and changes then this needs to be called.

Overrides:

arrayChanged in class ByteString

toString

public String toString(Charset charset,
              int start,
              int end)

Description copied from class: ByteString

Translates the [start, end) range of this byte string to a String using the charset encoding.

Overrides:

toString in class ByteString

compareTo

public int compareTo(CharSequence string)

Compares the specified string to this string using the ASCII values of the characters. Returns 0 if the strings contain the same characters in the same order. Returns a negative integer if the first non-equal character in this string has an ASCII value which is less than the ASCII value of the character at the same position in the specified string, or if this string is a prefix of the specified string. Returns a positive integer if the first non-equal character in this string has a ASCII value which is greater than the ASCII value of the character at the same position in the specified string, or if the specified string is a prefix of this string.

Specified by:

compareTo in interface Comparable<CharSequence>

Parameters:

string - the string to compare.

Returns:

0 if the strings are equal, a negative integer if this string is before the specified string, or a positive integer if this string is after the specified string.

Throws:

NullPointerException - if string is null.

concat

public AsciiString concat(CharSequence string)

Concatenates this string and the specified string.

Parameters:

string - the string to concatenate

Returns:

a new string which is the concatenation of this string and the specified string.

endsWith

public boolean endsWith(CharSequence suffix)

Compares the specified string to this string to determine if the specified string is a suffix.

Parameters:

suffix - the suffix to look for.

Returns:

true if the specified string is a suffix of this string, false otherwise.

Throws:

NullPointerException - if suffix is null.

contentEqualsIgnoreCase

public boolean contentEqualsIgnoreCase(CharSequence string)

Compares the specified string to this string ignoring the case of the characters and returns true if they are equal.

Parameters:

string - the string to compare.

Returns:

true if the specified string is equal to this string, false otherwise.

toCharArray

public char[] toCharArray()

Copies the characters in this string to a character array.

Returns:

a character array containing the characters of this string.

toCharArray

public char[] toCharArray(int start,
                 int end)

Copies the characters in this string to a character array.

Returns:

a character array containing the characters of this string.

copy

public void copy(int srcIdx,
        char[] dst,
        int dstIdx,
        int length)

Copied the content of this string to a character array.

Parameters:

srcIdx - the starting offset of characters to copy.

dst - the destination character array.

dstIdx - the starting offset in the destination byte array.

length - the number of characters to copy.

subSequence

public AsciiString subSequence(int start)

Description copied from class: ByteString

Copies a range of characters into a new string.

Overrides:

subSequence in class ByteString

Parameters:

start - the offset of the first character (inclusive).

Returns:

a new string containing the characters from start to the end of the string.

subSequence

public AsciiString subSequence(int start,
                      int end)

Description copied from class: ByteString

Copies a range of characters into a new string.

Specified by:

subSequence in interface CharSequence

Overrides:

subSequence in class ByteString

Parameters:

start - the offset of the first character (inclusive).

end - The index to stop at (exclusive).

Returns:

a new string containing the characters from start to the end of the string.

subSequence

public AsciiString subSequence(int start,
                      int end,
                      boolean copy)

Description copied from class: ByteString

Either copy or share a subset of underlying sub-sequence of bytes.

Overrides:

subSequence in class ByteString

Parameters:

start - the offset of the first character (inclusive).

end - The index to stop at (exclusive).

copy - If true then a copy of the underlying storage will be made. If false then the underlying storage will be shared.

Returns:

a new string containing the characters from start to the end of the string.

indexOf

public int indexOf(CharSequence string)

Searches in this string for the first index of the specified string. The search for the string starts at the beginning and moves towards the end of this string.

Parameters:

string - the string to find.

Returns:

the index of the first character of the specified string in this string, -1 if the specified string is not a substring.

Throws:

NullPointerException - if string is null.

indexOf

public int indexOf(CharSequence subString,
          int start)

Searches in this string for the index of the specified string. The search for the string starts at the specified offset and moves towards the end of this string.

Parameters:

subString - the string to find.

start - the starting offset.

Returns:

the index of the first character of the specified string in this string, -1 if the specified string is not a substring.

Throws:

NullPointerException - if subString is null.

lastIndexOf

public int lastIndexOf(CharSequence string)

Searches in this string for the last index of the specified string. The search for the string starts at the end and moves towards the beginning of this string.

Parameters:

string - the string to find.

Returns:

the index of the first character of the specified string in this string, -1 if the specified string is not a substring.

Throws:

NullPointerException - if string is null.

lastIndexOf

public int lastIndexOf(CharSequence subString,
              int start)

Searches in this string for the index of the specified string. The search for the string starts at the specified offset and moves towards the beginning of this string.

Parameters:

subString - the string to find.

start - the starting offset.

Returns:

the index of the first character of the specified string in this string , -1 if the specified string is not a substring.

Throws:

NullPointerException - if subString is null.

regionMatches

public boolean regionMatches(int thisStart,
                    CharSequence string,
                    int start,
                    int length)

Compares the specified string to this string and compares the specified range of characters to determine if they are the same.

Parameters:

thisStart - the starting offset in this string.

string - the string to compare.

start - the starting offset in the specified string.

length - the number of characters to compare.

Returns:

true if the ranges of characters are equal, false otherwise

Throws:

NullPointerException - if string is null.

regionMatches

public boolean regionMatches(boolean ignoreCase,
                    int thisStart,
                    CharSequence string,
                    int start,
                    int length)

Compares the specified string to this string and compares the specified range of characters to determine if they are the same. When ignoreCase is true, the case of the characters is ignored during the comparison.

Parameters:

ignoreCase - specifies if case should be ignored.

thisStart - the starting offset in this string.

string - the string to compare.

start - the starting offset in the specified string.

length - the number of characters to compare.

Returns:

true if the ranges of characters are equal, false otherwise.

Throws:

NullPointerException - if string is null.

replace

public AsciiString replace(char oldChar,
                  char newChar)

Copies this string replacing occurrences of the specified character with another character.

Parameters:

oldChar - the character to replace.

newChar - the replacement character.

Returns:

a new string with occurrences of oldChar replaced by newChar.

startsWith

public boolean startsWith(CharSequence prefix)

Compares the specified string to this string to determine if the specified string is a prefix.

Parameters:

prefix - the string to look for.

Returns:

true if the specified string is a prefix of this string, false otherwise

Throws:

NullPointerException - if prefix is null.

startsWith

public boolean startsWith(CharSequence prefix,
                 int start)

Compares the specified string to this string, starting at the specified offset, to determine if the specified string is a prefix.

Parameters:

prefix - the string to look for.

start - the starting offset.

Returns:

true if the specified string occurs in this string at the specified offset, false otherwise.

Throws:

NullPointerException - if prefix is null.

toLowerCase

public AsciiString toLowerCase()

Converts the characters in this string to lowercase, using the default Locale.

Returns:

a new string containing the lowercase characters equivalent to the characters in this string.

toUpperCase

public AsciiString toUpperCase()

Converts the characters in this string to uppercase, using the default Locale.

Returns:

a new string containing the uppercase characters equivalent to the characters in this string.

trim

public AsciiString trim()

Copies this string removing white space characters from the beginning and end of the string.

Returns:

a new string with characters <= \\u0020 removed from the beginning and the end.

contentEquals

public boolean contentEquals(CharSequence a)

Compares a CharSequence to this String to determine if their contents are equal.

Parameters:

a - the character sequence to compare to.

Returns:

true if equal, otherwise false

matches

public boolean matches(String expr)

Determines whether this string matches a given regular expression.

Parameters:

expr - the regular expression to be matched.

Returns:

true if the expression matches, otherwise false.

Throws:

PatternSyntaxException - if the syntax of the supplied regular expression is not valid.

NullPointerException - if expr is null.

split

public AsciiString[] split(String expr,
                  int max)

Splits this string using the supplied regular expression expr. The parameter max controls the behavior how many times the pattern is applied to the string.

Parameters:

expr - the regular expression used to divide the string.

max - the number of entries in the resulting array.

Returns:

an array of Strings created by separating the string along matches of the regular expression.

Throws:

NullPointerException - if expr is null.

PatternSyntaxException - if the syntax of the supplied regular expression is not valid.

See Also:

Pattern.split(CharSequence, int)

split

public AsciiString[] split(char delim)

Splits the specified String with the specified delimiter..

hashCodeCaseInsensitive

public int hashCodeCaseInsensitive()

Generate a hash code that will be consistent regardless of ASCII character casing.

NOTE: This must be compatible with caseInsensitiveHashCode(CharSequence).

caseInsensitiveHashCode

public static int caseInsensitiveHashCode(CharSequence value)

Returns the case-insensitive hash code of the specified string. Note that this method uses the same hashing algorithm with ByteString.hashCode() so that you can put both AsciiStrings and arbitrary CharSequences into the same TextHeaders.

hashCode

public static int hashCode(CharSequence value)

A case-sensitive version of caseInsensitiveHashCode(CharSequence).

Parameters:

value -

Returns:

contentEqualsIgnoreCase

public static boolean contentEqualsIgnoreCase(CharSequence a,
                              CharSequence b)

Returns true if both CharSequence's are equals when ignore the case. This only supports 8-bit ASCII.

contentEquals

public static boolean contentEquals(CharSequence a,
                    CharSequence b)

Returns true if the content of both CharSequence's are equals. This only supports 8-bit ASCII.

contains

public boolean contains(CharSequence cs)

Determines if this String contains the sequence of characters in the CharSequence passed.

Parameters:

cs - the character sequence to search for.

Returns:

true if the sequence of characters are contained in this string, otherwise false.