org.netpreserve.urlcanon

Class ByteString

java.lang.Object

org.netpreserve.urlcanon.ByteString

All Implemented Interfaces:

CharSequence, Comparable<ByteString>

public class ByteString
extends Object
implements CharSequence, Comparable<ByteString>

An immutable sequence of bytes. Similar to the 'bytes' type in Python. This class implements CharSequence so that we can operate on bytes using Java regular expressions. This is necessary as operations on URLs are specified in terms of bytes not unicode characters. The CharSequence methods in this class operate effectively as if this were a ISO-8859-1 String, but when we convert to and from String we decode and encode as UTF-8.

Field Summary

Fields

Modifier and Type	Field and Description
static ByteString	EMPTY
protected static Pattern	PCT_DECODE_REGEX

Constructor Summary

Constructors

Constructor and Description
ByteString(byte[] data)
ByteString(byte[] data, int off, int len)
ByteString(String s) Convert a String to a ByteString by encoding the chars as UTF-8 bytes.

Method Summary

Modifier and Type	Method and Description
ByteString	asciiLowerCase() Return a copy of this byte string with ASCII letters lower cased.
byte	byteAt(int index)
char	charAt(int index) The char of the byte value at the given index.
int	compareTo(ByteString other)
boolean	equals(CharSequence s)
boolean	equalsIgnoreCase(CharSequence s)
boolean	isEmpty() True if this byte string has a length of zero.
static ByteString	join(CharSequence delimiter, Iterable<? extends CharSequence> sequence)
int	length() The number of bytes in this ByteString.
ByteString	pctDecode()
ByteString	replace(byte target, byte replacement) Return a copy of this byte string with all bytes matching target replaced.
ByteString	replaceAll(Pattern pattern, CharSequence replacement)
List<ByteString>	split(char delim)
ByteString	subSequence(int start, int end)
byte[]	toByteArray() Return a copy as a byte array.
String	toString() Convert this byte sequence to a String by decoding it as UTF-8.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.CharSequence

chars, codePoints

Field Detail

EMPTY

public static final ByteString EMPTY

PCT_DECODE_REGEX

protected static Pattern PCT_DECODE_REGEX

Constructor Detail

ByteString

public ByteString(String s)

Convert a String to a ByteString by encoding the chars as UTF-8 bytes.

ByteString

public ByteString(byte[] data)

ByteString

public ByteString(byte[] data,
                  int off,
                  int len)

Method Detail

length

public int length()

The number of bytes in this ByteString.

Specified by:

length in interface CharSequence

charAt

public char charAt(int index)

The char of the byte value at the given index. No charset decoding is performed.

Specified by:

charAt in interface CharSequence

byteAt

public byte byteAt(int index)

subSequence

public ByteString subSequence(int start,
                              int end)

Specified by:

subSequence in interface CharSequence

toString

public String toString()

Convert this byte sequence to a String by decoding it as UTF-8. Beware: For non-ASCII strings, this deviates from the contract of CharSequence as toString() != charAt(0) + ... + charAt(length).

Specified by:

toString in interface CharSequence

Overrides:

toString in class Object

toByteArray

public byte[] toByteArray()

Return a copy as a byte array.

isEmpty

public boolean isEmpty()

True if this byte string has a length of zero.

join

public static ByteString join(CharSequence delimiter,
                              Iterable<? extends CharSequence> sequence)

replaceAll

public ByteString replaceAll(Pattern pattern,
                             CharSequence replacement)

pctDecode

public ByteString pctDecode()

replace

public ByteString replace(byte target,
                          byte replacement)

Return a copy of this byte string with all bytes matching target replaced.

asciiLowerCase

public ByteString asciiLowerCase()

Return a copy of this byte string with ASCII letters lower cased.

equalsIgnoreCase

public boolean equalsIgnoreCase(CharSequence s)

equals

public boolean equals(CharSequence s)

compareTo

public int compareTo(ByteString other)

Specified by:

compareTo in interface Comparable<ByteString>

split

public List<ByteString> split(char delim)