lightbulb_outline Help shape the future of the Google Play Console, Android Studio, and Firebase. Start survey

MessagePattern.Part

public static final class MessagePattern.Part
extends Object

java.lang.Object
   ↳ android.icu.text.MessagePattern.Part


A message pattern "part", representing a pattern parsing event. There is a part for the start and end of a message or argument, for quoting and escaping of and with ASCII apostrophes, and for syntax elements of "complex" arguments.

Summary

Nested classes

enum MessagePattern.Part.Type

Part type constants. 

Public methods

boolean equals(Object other)

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

MessagePattern.ArgType getArgType()

Returns the argument type if this part is of type ARG_START or ARG_LIMIT, otherwise ArgType.NONE.

int getIndex()

Returns the pattern string index associated with this Part.

int getLength()

Returns the length of the pattern substring associated with this Part.

int getLimit()

Returns the pattern string limit (exclusive-end) index associated with this Part.

MessagePattern.Part.Type getType()

Returns the type of this part.

int getValue()

Returns a value associated with this part.

int hashCode()

Returns a hash code value for the object.

String toString()

Returns a string representation of the object.

Inherited methods

Public methods

equals

added in API level 24
public boolean equals (Object other)

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.

The equals method for class Object implements the most discriminating possible equivalence relation on objects; that is, for any non-null reference values x and y, this method returns true if and only if x and y refer to the same object (x == y has the value true).

Note that it is generally necessary to override the hashCode method whenever this method is overridden, so as to maintain the general contract for the hashCode method, which states that equal objects must have equal hash codes.

Parameters
other Object: another object to compare with.

Returns
boolean true if this object is equivalent to the other one.

getArgType

added in API level 24
public MessagePattern.ArgType getArgType ()

Returns the argument type if this part is of type ARG_START or ARG_LIMIT, otherwise ArgType.NONE.

Returns
MessagePattern.ArgType the argument type for this part.

getIndex

added in API level 24
public int getIndex ()

Returns the pattern string index associated with this Part.

Returns
int this part's pattern string index.

getLength

added in API level 24
public int getLength ()

Returns the length of the pattern substring associated with this Part. This is 0 for some parts.

Returns
int this part's pattern substring length.

getLimit

added in API level 24
public int getLimit ()

Returns the pattern string limit (exclusive-end) index associated with this Part. Convenience method for getIndex()+getLength().

Returns
int this part's pattern string limit index, same as getIndex()+getLength().

getType

added in API level 24
public MessagePattern.Part.Type getType ()

Returns the type of this part.

Returns
MessagePattern.Part.Type the part type.

getValue

added in API level 24
public int getValue ()

Returns a value associated with this part. See the documentation of each part type for details.

Returns
int the part value.

hashCode

added in API level 24
public int hashCode ()

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by 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(Object) 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(java.lang.Object) 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.

As much as is reasonably practical, the hashCode method defined by class Object does return distinct integers for distinct objects. (This is typically implemented by converting the internal address of the object into an integer, but this implementation technique is not required by the Java™ programming language.)

Returns
int a hash code value for this object.

toString

added in API level 24
public String toString ()

Returns a string representation of the object. In general, the toString method returns a string that "textually represents" this object. The result should be a concise but informative representation that is easy for a person to read. It is recommended that all subclasses override this method.

The toString method for class Object returns a string consisting of the name of the class of which the object is an instance, the at-sign character `@', and the unsigned hexadecimal representation of the hash code of the object. In other words, this method returns a string equal to the value of:

 getClass().getName() + '@' + Integer.toHexString(hashCode())
 

Returns
String a string representation of this part.