net.nutch.io
Class UTF8

java.lang.Object
  net.nutch.io.UTF8

All Implemented Interfaces:

Comparable, Writable, WritableComparable

public class UTF8

extends Object

implements WritableComparable

A WritableComparable for strings that uses the UTF8 encoding.

Also includes utilities for efficiently reading and writing UTF-8.

Author:

Doug Cutting

Nested Class Summary

static class

UTF8.Comparator A WritableComparator optimized for UTF8 keys.

Constructor Summary

UTF8()

UTF8(String string)
Construct from a given string.

UTF8(UTF8 utf8)
Construct from a given string.

Method Summary

int	compareTo(Object o) Compare two UTF8s.
boolean	equals(Object o) Returns true iff o is a UTF8 with the same contents.
byte[]	getBytes() The raw bytes.
static byte[]	getBytes(String string) Convert a string to a UTF-8 encoded byte array.
int	getLength() The number of bytes in the encoded string.
void	readFields(DataInput in) Reads the fields of this object from in.
static String	readString(DataInput in) Read a UTF-8 encoded string.
void	set(String string) Set to contain the contents of a string.
void	set(UTF8 other) Set to contain the contents of a string.
static void	skip(DataInput in) Skips over one UTF8 in the input.
String	toString() Convert to a String.
void	write(DataOutput out) Writes the fields of this object to out.
static int	writeString(DataOutput out, String s) Write a UTF-8 encoded string.

Methods inherited from class java.lang.Object

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

Constructor Detail

UTF8

public UTF8()

UTF8

public UTF8(String string)

Construct from a given string.

UTF8

public UTF8(UTF8 utf8)

Construct from a given string.

Method Detail

getBytes

public byte[] getBytes()

The raw bytes.

getLength

public int getLength()

The number of bytes in the encoded string.

set

public void set(String string)

Set to contain the contents of a string.

set

public void set(UTF8 other)

Set to contain the contents of a string.

readFields

public void readFields(DataInput in)
                throws IOException

Description copied from interface: Writable

Reads the fields of this object from in. For efficiency, implementations should attempt to re-use storage in the existing object where possible.

Specified by:

readFields in interface Writable

Throws:

IOException

skip

public static void skip(DataInput in)
                 throws IOException

Skips over one UTF8 in the input.

Throws:

IOException

write

public void write(DataOutput out)
           throws IOException

Description copied from interface: Writable

Writes the fields of this object to out.

Specified by:

write in interface Writable

Throws:

IOException

compareTo

public int compareTo(Object o)

Compare two UTF8s.

Specified by:

compareTo in interface Comparable

toString

public String toString()

Convert to a String.

equals

public boolean equals(Object o)

Returns true iff o is a UTF8 with the same contents.

getBytes

public static byte[] getBytes(String string)

Convert a string to a UTF-8 encoded byte array.

See Also:

String.getBytes(String)

readString

public static String readString(DataInput in)
                         throws IOException

Read a UTF-8 encoded string.

Throws:

IOException

See Also:

DataInput.readUTF()

writeString

public static int writeString(DataOutput out,
                              String s)
                       throws IOException

Write a UTF-8 encoded string.

Throws:

IOException

See Also:

DataOutput.writeUTF(String)