com.ibm.icu.impl

Class ICUResource.Key

java.lang.Object

com.ibm.icu.impl.ICUResource.Key

All Implemented Interfaces:

CharSequence, Cloneable, Comparable<ICUResource.Key>

Enclosing class:

ICUResource

public static final class ICUResource.Key
extends Object
implements CharSequence, Cloneable, Comparable<ICUResource.Key>

Represents a resource bundle item's key string. Avoids object creations as much as possible. Mutable, not thread-safe. For permanent storage, use clone() or toString().

Constructor Summary

Constructors

Constructor and Description
Key() Constructs an empty resource key string object.

Method Summary

Modifier and Type	Method and Description
char	charAt(int i) Returns the character at index.
ICUResource.Key	clone() Creates and returns a copy of this Object.
int	compareTo(CharSequence cs)
int	compareTo(ICUResource.Key other) Compares this object to the specified object to determine their relative order.
boolean	contentEquals(CharSequence cs)
boolean	endsWith(CharSequence cs)
boolean	equals(Object other) Compares this instance with the specified object and indicates if they are equal.
int	hashCode() Returns an integer hash code for this object.
int	length() Returns the number of characters in this sequence.
void	setBytes(byte[] keyBytes, int keyOffset) Mutates this key for a new NUL-terminated resource key string.
void	setToEmpty() Mutates this key to an empty resource key string.
boolean	startsWith(CharSequence cs)
ICUResource.Key	subSequence(int start, int end) Returns a CharSequence from the start index (inclusive) to the end index (exclusive) of this sequence.
String	substring(int start) Creates a new Java String for a sub-sequence of this resource key string.
String	substring(int start, int end) Creates a new Java String for a sub-sequence of this resource key string.
String	toString() Creates/caches/returns this resource key string as a Java String.

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Key

public Key()

Constructs an empty resource key string object.

Method Detail

setBytes

public void setBytes(byte[] keyBytes,
                     int keyOffset)

Mutates this key for a new NUL-terminated resource key string. The corresponding ASCII-character bytes are not copied and must not be changed during the lifetime of this key (or until the next setBytes() call) and lifetimes of subSequences created from this key.

Parameters:

keyBytes - new key string byte array

keyOffset - new key string offset

setToEmpty

public void setToEmpty()

Mutates this key to an empty resource key string.

clone

public ICUResource.Key clone()

Creates and returns a copy of this Object. The default implementation returns a so-called "shallow" copy: It creates a new instance of the same class and then copies the field values (including object references) from this instance to the new instance. A "deep" copy, in contrast, would also recursively clone nested objects. A subclass that needs to implement this kind of cloning should call super.clone() to create the new instance and then create deep copies of the nested, mutable objects. Does not clone the byte array.

Overrides:

clone in class Object

Returns:

a copy of this object.

charAt

public char charAt(int i)

Description copied from interface: CharSequence

Returns the character at index.

Specified by:

charAt in interface CharSequence

length

public int length()

Description copied from interface: CharSequence

Returns the number of characters in this sequence.

Specified by:

length in interface CharSequence

Returns:

the number of characters.

subSequence

public ICUResource.Key subSequence(int start,
                                   int end)

Description copied from interface: CharSequence

Returns a CharSequence from the start index (inclusive) to the end index (exclusive) of this sequence.

Specified by:

subSequence in interface CharSequence

Parameters:

start - the start offset of the sub-sequence. It is inclusive, that is, the index of the first character that is included in the sub-sequence.

end - the end offset of the sub-sequence. It is exclusive, that is, the index of the first character after those that are included in the sub-sequence

Returns:

the requested sub-sequence.

toString

public String toString()

Creates/caches/returns this resource key string as a Java String.

Specified by:

toString in interface CharSequence

Overrides:

toString in class Object

Returns:

a printable representation of this object.

substring

public String substring(int start)

Creates a new Java String for a sub-sequence of this resource key string.

substring

public String substring(int start,
                        int end)

Creates a new Java String for a sub-sequence of this resource key string.

equals

public boolean equals(Object other)

Description copied from class: Object

Compares this instance with the specified object and indicates if they are equal. In order to be equal, o must represent the same object as this instance using a class-specific comparison. The general contract is that this comparison should be reflexive, symmetric, and transitive. Also, no object reference other than null is equal to null.

The default implementation returns true only if this == o. See Writing a correct equals method if you intend implementing your own equals method.

The general contract for the equals and Object.hashCode() methods is that if equals returns true for any two objects, then hashCode() must return the same value for these objects. This means that subclasses of Object usually override either both methods or neither of them.

Overrides:

equals in class Object

Parameters:

other - the object to compare this instance with.

Returns:

true if the specified object is equal to this Object; false otherwise.

See Also:

Object.hashCode()

contentEquals

public boolean contentEquals(CharSequence cs)

startsWith

public boolean startsWith(CharSequence cs)

endsWith

public boolean endsWith(CharSequence cs)

hashCode

public int hashCode()

Description copied from class: Object

Returns an integer hash code for this object. By contract, any two objects for which Object.equals(java.lang.Object) returns true must return the same hash code value. This means that subclasses of Object usually override both methods or neither method.

Note that hash values must not change over time unless information used in equals comparisons also changes.

See Writing a correct hashCode method if you intend implementing your own hashCode method.

Overrides:

hashCode in class Object

Returns:

this object's hash code.

See Also:

Object.equals(java.lang.Object)

compareTo

public int compareTo(ICUResource.Key other)

Description copied from interface: Comparable

Compares this object to the specified object to determine their relative order.

Specified by:

compareTo in interface Comparable<ICUResource.Key>

Parameters:

other - the object to compare to this instance.

Returns:

a negative integer if this instance is less than another; a positive integer if this instance is greater than another; 0 if this instance has the same order as another.

compareTo

public int compareTo(CharSequence cs)