Class MessagePattern.Part

  • Enclosing class:
    MessagePattern

    public static final class MessagePattern.Part
    extends java.lang.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

      Nested Classes 
      Modifier and Type Class Description
      static class  MessagePattern.Part.Type
      Part type constants.
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean equals​(java.lang.Object other)  
      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()
      java.lang.String toString()  
      • Methods inherited from class java.lang.Object

        clone, finalize, getClass, notify, notifyAll, wait, wait, wait
    • Method Detail

      • getIndex

        public int getIndex()
        Returns the pattern string index associated with this Part.
        Returns:
        this part's pattern string index.
      • getLength

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

        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().
      • getValue

        public int getValue()
        Returns a value associated with this part. See the documentation of each part type for details.
        Returns:
        the part value.
      • getArgType

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

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object
        Returns:
        a string representation of this part.
      • equals

        public boolean equals​(java.lang.Object other)
        Overrides:
        equals in class java.lang.Object
        Parameters:
        other - another object to compare with.
        Returns:
        true if this object is equivalent to the other one.
      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object