ByteString (LBJava 1.2.22 API)

java.lang.Object
- edu.illinois.cs.cogcomp.lbjava.util.ByteString

All Implemented Interfaces:

Cloneable, Comparable
```
public class ByteString
extends Object
implements Cloneable, Comparable
```
Represents a String by directly storing an encoding of that String in an array of bytes. This can save a lot of memory if all of the application's characters fit in a single byte when encoded by, for instance, UTF-8. In fact, the default encoding used by this class is UTF-8.

Author:

Nick Rizzolo

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`defaultEncoding` The default character encoding for instances of this class.
`static ByteString`	`emptyString` A byte string representing `""`.
`protected String`	`encoding` The encoding method used by this instance.
`protected int`	`hashCode` The hash code of the `String` decoding of this byte string.
`protected byte[]`	`value` The encoded characters.

Constructor Summary

Constructors
Modifier	Constructor and Description
	`ByteString()` Creates an empty byte string.
`protected`	`ByteString(boolean b)` For internal use only.
	`ByteString(ByteString b, String e)` Creates a byte string with the given encoding, which may involve converting the specified byte string's contents if the encodings differ.
	`ByteString(String s)` Creates a byte string by using the default encoding to encode the specified string.
	`ByteString(String s, String e)` Creates a byte string by using the specified encoding to encode the specified string.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ByteString`	`append(ByteString b)` Appends the string represented by the given byte string onto the existing content in this object.
`ByteString`	`append(ByteString[] b)` Appends the strings represented by the given byte strings onto the existing content in this object.
`ByteString`	`append(String s)` Appends the encoding of the given string onto the existing encoding in this object.
`ByteString`	`append(String[] s)` Appends the encodings of all the given strings onto the existing encoding in this object.
`Object`	`clone()` Returns a shallow copy of this string.
`int`	`compareTo(Object o)` If the argument object is a byte string, this object's byte array and the argument object's byte array are compared lexicographically.
`boolean`	`equals(Object o)` Two byte strings are equivalent if they encode the same string.
`byte`	`getByte(int i)` Returns the byte at index `i` of `value`.
`String`	`getEncoding()` Returns the name of the encoding method of this byte string.
`protected void`	`handleEncodingException(Exception e)` Handles exceptions generated by unsupported encodings.
`int`	`hashCode()` Returns a hash code for this object.
`int`	`length()` Returns the length of `value`.
`void`	`lexRead(edu.illinois.cs.cogcomp.core.datastructures.vectors.ExceptionlessInputStream in, ByteString i)` Reads the representation of a byte string as stored by a lexicon, overwriting the data in this object.
`static ByteString`	`lexReadByteString(edu.illinois.cs.cogcomp.core.datastructures.vectors.ExceptionlessInputStream in, ByteString i)` Reads and returns a byte string as written by a lexicon.
`void`	`lexWrite(edu.illinois.cs.cogcomp.core.datastructures.vectors.ExceptionlessOutputStream out, ByteString i)` Writes a binary representation of this byte string intended for use by a lexicon, omitting redundant information when possible.
`void`	`read(edu.illinois.cs.cogcomp.core.datastructures.vectors.ExceptionlessInputStream in)` Reads in a complete binary representation of a byte string.
`static ByteString`	`readByteString(edu.illinois.cs.cogcomp.core.datastructures.vectors.ExceptionlessInputStream in)` Reads and returns a byte string from an input stream.
`void`	`setValue(String s)` Sets the value of this byte string to the byte encoding of the specified string.
`String`	`toString()` Returns a decoded string.
`void`	`write(edu.illinois.cs.cogcomp.core.datastructures.vectors.ExceptionlessOutputStream out)` Writes a complete binary representation of this byte string.

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - defaultEncoding
```
public static final String defaultEncoding
```
    The default character encoding for instances of this class.
    
    See Also:
    
    Constant Field Values
  - emptyString
```
public static final ByteString emptyString
```
    A byte string representing "".
  - encoding
```
protected String encoding
```
    The encoding method used by this instance.
  - value
```
protected byte[] value
```
    The encoded characters.
  - hashCode
```
protected int hashCode
```
    The hash code of the String decoding of this byte string.
- Constructor Detail
  - ByteString
```
protected ByteString(boolean b)
```
    For internal use only.
    
    Parameters:
    
    b - Dummy variable to make a new signature.
  - ByteString
```
public ByteString()
```
    Creates an empty byte string.
  - ByteString
```
public ByteString(String s)
```
    Creates a byte string by using the default encoding to encode the specified string.
    
    Parameters:
    
    s - The string to encode.
  - ByteString
```
public ByteString(String s,
                  String e)
```
    Creates a byte string by using the specified encoding to encode the specified string.
    
    Parameters:
    
    s - The string to encode.
    
    e - The encoding method.
  - ByteString
```
public ByteString(ByteString b,
                  String e)
```
    Creates a byte string with the given encoding, which may involve converting the specified byte string's contents if the encodings differ.
    
    Parameters:
    
    b - The original byte string.
    
    e - The new encoding.
- Method Detail
  - handleEncodingException
```
protected void handleEncodingException(Exception e)
```
    Handles exceptions generated by unsupported encodings.
    
    Parameters:
    
    e - The exception.
  - readByteString
```
public static ByteString readByteString(edu.illinois.cs.cogcomp.core.datastructures.vectors.ExceptionlessInputStream in)
```
    Reads and returns a byte string from an input stream.
    
    Parameters:
    
    in - The input stream.
    
    Returns:
    
    The byte string.
  - lexReadByteString
```
public static ByteString lexReadByteString(edu.illinois.cs.cogcomp.core.datastructures.vectors.ExceptionlessInputStream in,
                                           ByteString i)
```
    Reads and returns a byte string as written by a lexicon.
    
    Parameters:
    
    in - The input stream.
    
    i - The assumed identifier. If no identifier is given in the input stream, the instantiated feature is given this identifier.
    
    Returns:
    
    The byte string.
  - getEncoding
```
public String getEncoding()
```
    Returns the name of the encoding method of this byte string.
  - setValue
```
public void setValue(String s)
```
    Sets the value of this byte string to the byte encoding of the specified string.
    
    Parameters:
    
    s - The string to encode.
  - length
```
public int length()
```
    Returns the length of value.
  - getByte
```
public byte getByte(int i)
```
    Returns the byte at index i of value.
    
    Parameters:
    
    i - The index of the requested byte.
    
    Returns:
    
    The value of the requested byte.
  - append
```
public ByteString append(String s)
```
    Appends the encoding of the given string onto the existing encoding in this object. This operation changes the value reference in this object.
    Warning: Depending on the character encoding in use, this may introduce byte order markers into the middle of this object's byte array, which usually is not desired.
    
    Parameters:
    
    s - The string whose encoding will be appended.
    
    Returns:
    
    This object.
  - append
```
public ByteString append(String[] s)
```
    Appends the encodings of all the given strings onto the existing encoding in this object. This operation changes the value reference in this object.
    Warning: Depending on the character encoding in use, this may introduce byte order markers into the middle of this object's byte array, which usually is not desired.
    
    Parameters:
    
    s - The strings whose encodings will be appended.
    
    Returns:
    
    This object.
  - append
```
public ByteString append(ByteString b)
```
    Appends the string represented by the given byte string onto the existing content in this object. This operation changes the value reference in this object.
    Warning: Depending on the character encoding in use, this may introduce byte order markers into the middle of this object's byte array, which usually is not desired.
    
    Parameters:
    
    b - The string whose encoding will be appended.
    
    Returns:
    
    This object.
  - append
```
public ByteString append(ByteString[] b)
```
    Appends the strings represented by the given byte strings onto the existing content in this object. This operation changes the value reference in this object.
    Warning: Depending on the character encoding in use, this may introduce byte order markers into the middle of this object's byte array, which usually is not desired.
    
    Parameters:
    
    b - The strings whose encodings will be appended.
    
    Returns:
    
    This object.
  - compareTo
```
public int compareTo(Object o)
```
    If the argument object is a byte string, this object's byte array and the argument object's byte array are compared lexicographically. Otherwise, -1 is returned. Of course, this operation is considerably more expensive if the two strings do not share the same encoding.
    
    Specified by:
    
    compareTo in interface Comparable
  - hashCode
```
public int hashCode()
```
    Returns a hash code for this object.
    
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object o)
```
    Two byte strings are equivalent if they encode the same string. This operation is more expensive if the two byte strings use different encodings.
    
    Overrides:
    
    equals in class Object
  - write
```
public void write(edu.illinois.cs.cogcomp.core.datastructures.vectors.ExceptionlessOutputStream out)
```
    Writes a complete binary representation of this byte string.
    
    Parameters:
    
    out - The output stream.
  - read
```
public void read(edu.illinois.cs.cogcomp.core.datastructures.vectors.ExceptionlessInputStream in)
```
    Reads in a complete binary representation of a byte string.
    
    Parameters:
    
    in - The input stream.
  - lexWrite
```
public void lexWrite(edu.illinois.cs.cogcomp.core.datastructures.vectors.ExceptionlessOutputStream out,
                     ByteString i)
```
    Writes a binary representation of this byte string intended for use by a lexicon, omitting redundant information when possible.
    
    Parameters:
    
    out - The output stream.
    
    i - The assumed identifier string. This byte strings value, encoding, or both may be omitted if they are equivalent to i.
  - lexRead
```
public void lexRead(edu.illinois.cs.cogcomp.core.datastructures.vectors.ExceptionlessInputStream in,
                    ByteString i)
```
    Reads the representation of a byte string as stored by a lexicon, overwriting the data in this object.
    This method is appropriate for reading byte strings as written by lexWrite(ExceptionlessOutputStream,ByteString).
    
    Parameters:
    
    in - The input stream.
    
    i - The assumed identifier string.
  - toString
```
public String toString()
```
    Returns a decoded string.
    
    Overrides:
    
    toString in class Object
  - clone
```
public Object clone()
```
    Returns a shallow copy of this string. Note that this class does not provide any operations that modify the contents of the objects referenced by its fields, making a deep clone unnecessary. (append(String), append(ByteString), and setValue(String) modify the value field itself, but the reference is merely replaced; the contents of the original array do not change.)
    
    Overrides:
    
    clone in class Object

Class ByteString

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

defaultEncoding

emptyString

encoding

value

hashCode

Constructor Detail

ByteString

ByteString

ByteString

ByteString

ByteString

Method Detail

handleEncodingException

readByteString

lexReadByteString

getEncoding

setValue

length

getByte

append

append

append

append

compareTo

hashCode

equals

write

read

lexWrite

lexRead

toString

clone