Class Token

java.lang.Object
org.tweetyproject.lp.asp.parser.Token
All Implemented Interfaces:
Serializable
public class Token extends Object implements Serializable
Describes the input token stream.
See Also:

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    int
    beginColumn
    The column number of the first character of this Token.
    int
    beginLine
    The line number of the first character of this Token.
    int
    endColumn
    The column number of the last character of this Token.
    int
    endLine
    The line number of the last character of this Token.
    String
    image
    The string image of the token.
    int
    kind
    An integer that describes the kind of this token.
    Token
    next
    A reference to the next regular (non-special) token from the input stream.
    Token
    specialToken
    This field is used to access special tokens that occur prior to this token, but after the immediately preceding regular (non-special) token.

  • Constructor Summary

    Constructors
    Constructor
    Description
    Token()
    Constructs a new Token with no initial kind or image.
    Token(int kind)
    Constructs a new Token with the specified kind.
    Token(int kind, String image)
    Constructs a new Token with the specified kind and image.

  • Method Summary

    Modifier and Type
    Method
    Description
    Object
    getValue()
    An optional attribute value of the token.
    static Token
    newToken(int ofKind)
    Creates and returns a new Token object with the specified kind and a null image.
    static Token
    newToken(int ofKind, String image)
    Creates and returns a new Token object with the specified kind and image.
    String
    toString()
    Returns the image of the token.

    Methods inherited from class java.lang.Object

    equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

  • Field Details

    • kind

      public int kind
      An integer that describes the kind of this token. This numbering system is determined by JavaCCParser, and a table of these numbers is stored in the file ...Constants.java.

    • beginLine

      public int beginLine
      The line number of the first character of this Token.

    • beginColumn

      public int beginColumn
      The column number of the first character of this Token.

    • endLine

      public int endLine
      The line number of the last character of this Token.

    • endColumn

      public int endColumn
      The column number of the last character of this Token.

    • image

      public String image
      The string image of the token.

    • next

      public Token next
      A reference to the next regular (non-special) token from the input stream. If this is the last token from the input stream, or if the token manager has not read tokens beyond this one, this field is set to null. This is true only if this token is also a regular token. Otherwise, see below for a description of the contents of this field.

    • specialToken

      public Token specialToken
      This field is used to access special tokens that occur prior to this token, but after the immediately preceding regular (non-special) token. If there are no such special tokens, this field is set to null. When there are more than one such special token, this field refers to the last of these special tokens, which in turn refers to the next previous special token through its specialToken field, and so on until the first special token (whose specialToken field is null). The next fields of special tokens refer to other special tokens that immediately follow it (without an intervening regular token). If there is no such token, this field is null.

  • Constructor Details

    • Token

      public Token()
      Constructs a new Token with no initial kind or image.

      This is a no-argument constructor that initializes the token with default values.

    • Token

      public Token(int kind)
      Constructs a new Token with the specified kind.

      The kind parameter typically represents the type of token, such as an identifier, keyword, or operator. This constructor initializes the token with the given kind and a null image.

      Parameters:
      kind - The kind of token.

    • Token

      public Token(int kind, String image)
      Constructs a new Token with the specified kind and image.

      This constructor initializes the token with the given kind and image, which represents the textual representation of the token.

      Parameters:
      kind - The kind of token.
      image - The string representation of the token.

  • Method Details

    • getValue

      public Object getValue()
      An optional attribute value of the token.

      Tokens that are not just syntactic sugar often contain meaningful values that will be used later by the compiler or interpreter. This attribute value is often different from the token's image. Subclasses of Token can override this method to return a meaningful value.

      Returns:
      The value associated with this token, or null by default.

    • toString

      public String toString()
      Returns the image of the token.

      The image is the string representation of the token as it appears in the source code.

      Overrides:
      toString in class Object
      Returns:
      The string representation of the token.

    • newToken

      public static Token newToken(int ofKind, String image)
      Creates and returns a new Token object with the specified kind and image.

      This method allows for the creation of tokens with specific characteristics, such as their kind (type) and their image (string representation). By default, it returns an instance of the Token class. However, this method can be customized to return different subclasses of Token depending on the value of ofKind.

      Parameters:
      ofKind - The kind of token to be created, typically representing a specific type such as an identifier, keyword, or operator.
      image - The string representation of the token. This may be null if the token does not require a specific image.
      Returns:
      A new Token object with the specified kind and image.

    • newToken

      public static Token newToken(int ofKind)
      Creates and returns a new Token object with the specified kind and a null image.

      This method is a convenience method for creating tokens when no specific image is required. It calls newToken(int, String) with null as the image.

      Parameters:
      ofKind - The kind of token to be created, typically representing a specific type such as an identifier, keyword, or operator.
      Returns:
      A new Token object with the specified kind and a null image.