001/*
002 * Units of Measurement Reference Implementation
003 * Copyright (c) 2005-2025, Jean-Marie Dautelle, Werner Keil, Otavio Santana.
004 *
005 * All rights reserved.
006 *
007 * Redistribution and use in source and binary forms, with or without modification,
008 * are permitted provided that the following conditions are met:
009 *
010 * 1. Redistributions of source code must retain the above copyright notice,
011 *    this list of conditions and the following disclaimer.
012 *
013 * 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions
014 *    and the following disclaimer in the documentation and/or other materials provided with the distribution.
015 *
016 * 3. Neither the name of JSR-385, Indriya nor the names of their contributors may be used to endorse or promote products
017 *    derived from this software without specific prior written permission.
018 *
019 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
020 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
021 * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
022 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
023 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
024 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
025 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
026 * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
027 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
028 * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
029 */
030package tech.units.indriya.format;
031
032/**
033 * Describes the input token stream.
034 *
035 * @version 5.4, September 26, 2020
036 */
037
038public final class Token {
039
040  /**
041   * The Serialization identifier for this class. Increment only if the <i>serialized</i> form of the class changes.
042   */
043  // private static final long serialVersionUID = 2188279658897600591L;
044
045  /**
046   * 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
047   * the file ...Constants.java.
048   */
049  public int kind;
050
051  /** The line number of the first character of this Token. */
052  public int beginLine;
053  /** The column number of the first character of this Token. */
054  public int beginColumn;
055  /** The line number of the last character of this Token. */
056  public int endLine;
057  /** The column number of the last character of this Token. */
058  public int endColumn;
059
060  /**
061   * The string image of the token.
062   */
063  public String image;
064
065  /**
066   * 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
067   * 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
068   * below for a description of the contents of this field.
069   */
070  public Token next;
071
072  /**
073   * This field is used to access special tokens that occur prior to this token, but after the immediately preceding regular (non-special) token. If
074   * 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
075   * these special tokens, which in turn refers to the next previous special token through its specialToken field, and so on until the first special
076   * token (whose specialToken field is null). The next fields of special tokens refer to other special tokens that immediately follow it (without an
077   * intervening regular token). If there is no such token, this field is null.
078   */
079  public Token specialToken;
080
081  /**
082   * An optional attribute value of the Token. Tokens which are not used as syntactic sugar will often contain meaningful values that will be used
083   * later on by the compiler or interpreter. This attribute value is often different from the image. Any subclass of Token that actually wants to
084   * return a non-null value can override this method as appropriate.
085   */
086  public Object getValue() {
087    return null;
088  }
089
090  /**
091   * No-argument constructor
092   */
093  public Token() {
094  }
095
096  /**
097   * Constructs a new token for the specified Image and Kind.
098   */
099  private Token(int kind, String image) {
100    this.kind = kind;
101    this.image = image;
102  }
103
104  /**
105   * Returns the image.
106   */
107  public String toString() {
108    return image;
109  }
110
111  /**
112   * Returns a new Token object, by default. However, if you want, you can create and return subclass objects based on the value of ofKind. Simply add
113   * the cases to the switch for all those special cases. For example, if you have a subclass of Token called IDToken that you want to create if
114   * ofKind is ID, simply add something like :
115   *
116   * case MyParserConstants.ID : return new IDToken(ofKind, image);
117   *
118   * to the following switch statement. Then you can cast matchedToken variable to the appropriate type and use sit in your lexical actions.
119   */
120  public static Token of(int ofKind, String image) {
121    switch (ofKind) {
122      default:
123        return new Token(ofKind, image);
124    }
125  }
126
127  public static Token of(int ofKind) {
128    return of(ofKind, null);
129  }
130
131}
132/*
133 * JavaCC - OriginalChecksum=08d08345e10cca30522247698d4478e6 (do not edit this
134 * line)
135 */