MessagePattern.Part

public static final class MessagePattern.Part extends Object

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.

Nested Class Summary

enum MessagePattern.Part.Type Part type constants. 

Public Method Summary

boolean
equals(Object other)
Compares this instance with the specified object and indicates if they are equal.
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 an integer hash code for this object.
String
toString()
Returns a string containing a concise, human-readable description of this object.

Inherited Method Summary

Public Methods

public boolean equals (Object other)

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 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.

Parameters
other another object to compare with.
Returns
  • true if this object is equivalent to the other one.

public MessagePattern.ArgType getArgType ()

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

Returns
  • the argument type for this part.

public int getIndex ()

Returns the pattern string index associated with this Part.

Returns
  • this part's pattern string index.

public int getLength ()

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

Returns
  • this part's pattern substring length.

public int getLimit ()

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

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

public MessagePattern.Part.Type getType ()

Returns the type of this part.

Returns
  • the part type.

public int getValue ()

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

Returns
  • the part value.

public int hashCode ()

Returns an integer hash code for this object. By contract, any two objects for which equals(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.

Returns
  • this object's hash code.

public String toString ()

Returns a string containing a concise, human-readable description of this object. Subclasses are encouraged to override this method and provide an implementation that takes into account the object's type and data. The default implementation is equivalent to the following expression:

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

See Writing a useful toString method if you intend implementing your own toString method.

Returns
  • a string representation of this part.