Apache Avro 1.11.3 · org.apache.avro.util.Utf8

Modifier and Type	Field and Description
private byte[]	bytes
private static final byte[]	EMPTY
private int	hash
private int	length
private String	string

Access	Constructor and Description
public	Utf8()
public	Utf8(String string)
public	Utf8(Utf8 other)
public	Utf8(byte[] bytes)

Method Summary

Modifier and Type	Method and Description
public char	charAt(int the index of the `char` value to be returned index) Implements java.lang.CharSequence.charAt. Returns the `char` value at the specified index.
public int	compareTo(Utf8 the object to be compared. that) Implements java.lang.Comparable.compareTo. Compares this object with the specified object for order.
public boolean	equals(Object the reference object with which to compare. o) Overrides java.lang.Object.equals. Indicates whether some other object is "equal to" this one.
public int	getByteLength() Return length in bytes.
public byte[]	getBytes() Return UTF-8 encoded bytes.
public static byte[]	getBytesFor(String str) Gets the UTF-8 bytes for a String
public int	getLength() Deprecated call `getByteLength()` instead. Return length in bytes.
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for the object.
public int	length() Implements java.lang.CharSequence.length. Returns the length of this character sequence.
public void	readExternal(ObjectInput the stream to read data from in order to restore the object in) Implements java.io.Externalizable.readExternal. The object implements the readExternal method to restore its contents by calling the methods of DataInput for primitive types and readObject for objects, strings and arrays.
public Utf8	set(String string) Set to the contents of a String.
public Utf8	set(Utf8 other)
public Utf8	setByteLength(int newLength) Set length in bytes.
public Utf8	setLength(int newLength) Deprecated call `setByteLength(int)` instead. Set length in bytes.
public CharSequence	subSequence(int the start index, inclusive start, int the end index, exclusive end) Implements java.lang.CharSequence.subSequence. Returns a `CharSequence` that is a subsequence of this sequence.
public String	toString() Overrides java.lang.Object.toString. Implements java.lang.CharSequence.toString. Returns a string containing the characters in this sequence in the same order as this sequence.
public void	writeExternal(ObjectOutput the stream to write the object to out) Implements java.io.Externalizable.writeExternal. The object implements the writeExternal method to save its contents by calling the methods of DataOutput for its primitive values or calling the writeObject method of ObjectOutput for objects, strings, and arrays.

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

bytes	back to summary
private byte[] bytes

EMPTY	back to summary
private static final byte[] EMPTY

hash	back to summary
private int hash

length	back to summary
private int length

string	back to summary
private String string

Utf8	back to summary
public Utf8()

Utf8	back to summary
public Utf8(String string)

Utf8	back to summary
public Utf8(Utf8 other)

Utf8	back to summary
public Utf8(byte[] bytes)

Method Detail

charAt back to summary

charAt	back to summary
public char charAt(int index) Implements java.lang.CharSequence.charAt. Doc from java.lang.CharSequence.charAt. Returns the `char` value at the specified index. An index ranges from zero to `length() - 1`. The first `char` value of the sequence is at index zero, the next at index one, and so on, as for array indexing. If the `char` value specified by the index is a surrogate, the surrogate value is returned. Parameters index:int the index of the `char` value to be returned Returns:char the specified `char` value Annotations @Override

public char charAt(int index)

Implements java.lang.CharSequence.charAt.

Doc from java.lang.CharSequence.charAt.

Returns the char value at the specified index. An index ranges from zero to length() - 1. The first char value of the sequence is at index zero, the next at index one, and so on, as for array indexing.

If the char value specified by the index is a surrogate, the surrogate value is returned.

Parameters

index:int: the index of the char value to be returned

Returns:char

the specified char value

Annotations

@Override

compareTo back to summary

compareTo	back to summary
public int compareTo(Utf8 that) Implements java.lang.Comparable.compareTo. Doc from java.lang.Comparable.compareTo. Compares this object with the specified object for order. Returns a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object. The implementor must ensure `signum(x.compareTo(y)) == -signum(y.compareTo(x))` for all `x` and `y`. (This implies that `x.compareTo(y)` must throw an exception if and only if `y.compareTo(x)` throws an exception.) The implementor must also ensure that the relation is transitive: `(x.compareTo(y) > 0 && y.compareTo(z) > 0)` implies `x.compareTo(z) > 0`. Finally, the implementor must ensure that `x.compareTo(y)==0` implies that `signum(x.compareTo(z)) == signum(y.compareTo(z))`, for all `z`. Parameters that:Utf8 the object to be compared. Returns:int a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object. Annotations @Override

public int compareTo(Utf8 that)

Implements java.lang.Comparable.compareTo.

Doc from java.lang.Comparable.compareTo.

Compares this object with the specified object for order. Returns a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.

The implementor must ensure signum(x.compareTo(y)) == -signum(y.compareTo(x)) for all x and y. (This implies that x.compareTo(y) must throw an exception if and only if y.compareTo(x) throws an exception.)

The implementor must also ensure that the relation is transitive: (x.compareTo(y) > 0 && y.compareTo(z) > 0) implies x.compareTo(z) > 0.

Finally, the implementor must ensure that x.compareTo(y)==0 implies that signum(x.compareTo(z)) == signum(y.compareTo(z)), for all z.

Parameters

that:Utf8: the object to be compared.

Returns:int

a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.

Annotations

@Override

equals back to summary

equals	back to summary
public boolean equals(Object o) Overrides java.lang.Object.equals. Doc from java.lang.Object.equals. Indicates whether some other object is "equal to" this one. The `equals` method implements an equivalence relation on non-null object references: It is reflexive: for any non-null reference value `x`, `x.equals(x)` should return `true`. It is symmetric: for any non-null reference values `x` and `y`, `x.equals(y)` should return `true` if and only if `y.equals(x)` returns `true`. It is transitive: for any non-null reference values `x`, `y`, and `z`, if `x.equals(y)` returns `true` and `y.equals(z)` returns `true`, then `x.equals(z)` should return `true`. It is consistent: for any non-null reference values `x` and `y`, multiple invocations of `x.equals(y)` consistently return `true` or consistently return `false`, provided no information used in `equals` comparisons on the objects is modified. For any non-null reference value `x`, `x.equals(null)` should return `false`. An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes. Parameters o:Object the reference object with which to compare. Returns:boolean `true` if this object is the same as the obj argument; `false` otherwise. Annotations @Override

public boolean equals(Object o)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

It is reflexive: for any non-null reference value x, x.equals(x) should return true.
It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters

o:Object: the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

Annotations

@Override

getByteLength	back to summary
public int getByteLength() Return length in bytes.

getBytes	back to summary
public byte[] getBytes() Return UTF-8 encoded bytes. Only valid through `getByteLength()`.

getBytesFor	back to summary
public static byte[] getBytesFor(String str) Gets the UTF-8 bytes for a String

getLength back to summary

getLength	back to summary
public int getLength() Deprecated call `getByteLength()` instead. Return length in bytes. Annotations @Deprecated

public int getLength()

Deprecated

call getByteLength() instead.

Return length in bytes.

Annotations

@Deprecated

hashCode back to summary

hashCode	back to summary
public int hashCode() Overrides java.lang.Object.hashCode. Doc from java.lang.Object.hashCode. Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by `java.util.HashMap`. The general contract of `hashCode` is: Whenever it is invoked on the same object more than once during an execution of a Java application, the `hashCode` method must consistently return the same integer, provided no information used in `equals` comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application. If two objects are equal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce the same integer result. It is not required that if two objects are unequal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables. Returns:int a hash code value for this object. Annotations @Override

public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

Returns:int

a hash code value for this object.

Annotations

@Override

length back to summary

length	back to summary
public int length() Implements java.lang.CharSequence.length. Doc from java.lang.CharSequence.length. Returns the length of this character sequence. The length is the number of 16-bit `char`s in the sequence. Returns:int the number of `char`s in this sequence Annotations @Override

public int length()

Implements java.lang.CharSequence.length.

Doc from java.lang.CharSequence.length.

Returns the length of this character sequence. The length is the number of 16-bit chars in the sequence.

Returns:int

the number of chars in this sequence

Annotations

@Override

readExternal	back to summary
public void readExternal(ObjectInput in) throws IOException, ClassNotFoundException Implements java.io.Externalizable.readExternal. Doc from java.io.Externalizable.readExternal. The object implements the readExternal method to restore its contents by calling the methods of DataInput for primitive types and readObject for objects, strings and arrays. The readExternal method must read the values in the same sequence and with the same types as were written by writeExternal. Parameters in:ObjectInput the stream to read data from in order to restore the object Annotations @Override Exceptions IOException: if I/O errors occur ClassNotFoundException: If the class for an object being restored cannot be found.

readExternal

back to summary

public void readExternal(ObjectInput in) throws IOException, ClassNotFoundException

Implements java.io.Externalizable.readExternal.

Doc from java.io.Externalizable.readExternal.

The object implements the readExternal method to restore its contents by calling the methods of DataInput for primitive types and readObject for objects, strings and arrays. The readExternal method must read the values in the same sequence and with the same types as were written by writeExternal.

Parameters

in:ObjectInput: the stream to read data from in order to restore the object

Annotations

@Override

Exceptions

IOException:: if I/O errors occur
ClassNotFoundException:: If the class for an object being restored cannot be found.

set	back to summary
public Utf8 set(String string) Set to the contents of a String.

set	back to summary
public Utf8 set(Utf8 other)

setByteLength	back to summary
public Utf8 setByteLength(int newLength) Set length in bytes. Should called whenever byte content changes, even if the length does not change, as this also clears the cached String.

setLength back to summary

setLength	back to summary
public Utf8 setLength(int newLength) Deprecated call `setByteLength(int)` instead. Set length in bytes. Should called whenever byte content changes, even if the length does not change, as this also clears the cached String. Annotations @Deprecated

public Utf8 setLength(int newLength)

Deprecated

call setByteLength(int) instead.

Set length in bytes. Should called whenever byte content changes, even if the length does not change, as this also clears the cached String.

Annotations

@Deprecated

subSequence back to summary

subSequence	back to summary
public CharSequence subSequence(int start, int end) Implements java.lang.CharSequence.subSequence. Doc from java.lang.CharSequence.subSequence. Returns a `CharSequence` that is a subsequence of this sequence. The subsequence starts with the `char` value at the specified index and ends with the `char` value at index `end - 1`. The length (in `char`s) of the returned sequence is `end - start`, so if `start == end` then an empty sequence is returned. Parameters start:int the start index, inclusive end:int the end index, exclusive Returns:CharSequence the specified subsequence Annotations @Override

public CharSequence subSequence(int start, int end)

Implements java.lang.CharSequence.subSequence.

Doc from java.lang.CharSequence.subSequence.

Returns a CharSequence that is a subsequence of this sequence. The subsequence starts with the char value at the specified index and ends with the char value at index end - 1. The length (in chars) of the returned sequence is end - start, so if start == end then an empty sequence is returned.

Parameters

start:int: the start index, inclusive
end:int: the end index, exclusive

Returns:CharSequence

the specified subsequence

Annotations

@Override

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Implements java.lang.CharSequence.toString. Doc from java.lang.CharSequence.toString. Returns a string containing the characters in this sequence in the same order as this sequence. The length of the string will be the length of this sequence. Returns:String a string consisting of exactly this sequence of characters Annotations @Override

toString

back to summary

public String toString()

Overrides java.lang.Object.toString.

Implements java.lang.CharSequence.toString.

Doc from java.lang.CharSequence.toString.

Returns a string containing the characters in this sequence in the same order as this sequence. The length of the string will be the length of this sequence.

Returns:String

a string consisting of exactly this sequence of characters

Annotations

@Override

writeExternal	back to summary
public void writeExternal(ObjectOutput out) throws IOException Implements java.io.Externalizable.writeExternal. Doc from java.io.Externalizable.writeExternal. The object implements the writeExternal method to save its contents by calling the methods of DataOutput for its primitive values or calling the writeObject method of ObjectOutput for objects, strings, and arrays. Parameters out:ObjectOutput the stream to write the object to Annotations @Override Exceptions IOException: Includes any I/O exceptions that may occur

writeExternal

back to summary

public void writeExternal(ObjectOutput out) throws IOException

Implements java.io.Externalizable.writeExternal.

Doc from java.io.Externalizable.writeExternal.

The object implements the writeExternal method to save its contents by calling the methods of DataOutput for its primitive values or calling the writeObject method of ObjectOutput for objects, strings, and arrays.

Parameters

out:ObjectOutput: the stream to write the object to

Annotations

@Override

Exceptions

IOException:: Includes any I/O exceptions that may occur

public Class Utf8

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail