Package com.yahoo.prelude.query.parser

Class Token

  • public class Token
extends java.lang.Object
    A query token.
    Author:
    bratseth

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  Token.Kind  

    • Constructor Summary

      Constructors 
      Constructor Description
      Token​(Token.Kind kind, java.lang.String image)
      Crates a token which fails to know its origin (as a substring).
      Token​(Token.Kind kind, java.lang.String image, boolean special, Substring substring)  
      Token​(Token.Kind kind, java.lang.String image, Substring substring)  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean equals​(java.lang.Object object)  
      Substring getSubstring()
      Returns the substring containing the image ins original form (including casing), as well as all the text surrounding the token
      int hashCode()  
      boolean isSpecial()
      Returns whether this is a special token
      java.lang.String toString()  

      • Methods inherited from class java.lang.Object

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

    • Field Detail

      • substring

        public final Substring substring
        The raw substring causing this token, never null

      • image

        public final java.lang.String image
        Lowercase image

    • Constructor Detail

      • Token

        public Token​(Token.Kind kind,
             java.lang.String image)
        Crates a token which fails to know its origin (as a substring). Do not use, except for testing.

      • Token

        public Token​(Token.Kind kind,
             java.lang.String image,
             boolean special,
             Substring substring)

    • Method Detail

      • isSpecial

        public boolean isSpecial()
        Returns whether this is a special token

      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object

      • equals

        public boolean equals​(java.lang.Object object)
        Overrides:
        equals in class java.lang.Object

      • getSubstring

        public Substring getSubstring()
        Returns the substring containing the image ins original form (including casing), as well as all the text surrounding the token
        Returns:
        the image in original casing, never null

      • hashCode

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