com.ezylang.evalex.parser.Token Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of EvalEx Show documentation

EvalEx is a handy expression evaluator for Java, that allows to evaluate expressions.

There is a newer version: 3.4.0

/*
  Copyright 2012-2022 Udo Klimaschewski

  Licensed under the Apache License, Version 2.0 (the "License");
  you may not use this file except in compliance with the License.
  You may obtain a copy of the License at

      http://www.apache.org/licenses/LICENSE-2.0

  Unless required by applicable law or agreed to in writing, software
  distributed under the License is distributed on an "AS IS" BASIS,
  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  See the License for the specific language governing permissions and
  limitations under the License.
*/
package com.ezylang.evalex.parser;

import com.ezylang.evalex.functions.FunctionIfc;
import com.ezylang.evalex.operators.OperatorIfc;
import lombok.AllArgsConstructor;
import lombok.EqualsAndHashCode;
import lombok.ToString;
import lombok.Value;

/**
 * A token represents a single part of an expression, like an operator, number literal, or a brace.
 * Each token has a unique type, a value (its representation) and a position (starting with 1) in
 * the original expression string.
 *
 * For operators and functions, the operator and function definition is also set during parsing.
 */
@Value
@AllArgsConstructor
@EqualsAndHashCode(doNotUseGetters = true)
public class Token {

  public enum TokenType {
    BRACE_OPEN,
    BRACE_CLOSE,
    COMMA,
    STRING_LITERAL,
    NUMBER_LITERAL,
    VARIABLE_OR_CONSTANT,
    INFIX_OPERATOR,
    PREFIX_OPERATOR,
    POSTFIX_OPERATOR,
    FUNCTION,
    FUNCTION_PARAM_START,
    ARRAY_OPEN,
    ARRAY_CLOSE,
    ARRAY_INDEX,
    STRUCTURE_SEPARATOR
  }

  int startPosition;

  String value;

  TokenType type;

  @EqualsAndHashCode.Exclude @ToString.Exclude FunctionIfc functionDefinition;

  @EqualsAndHashCode.Exclude @ToString.Exclude OperatorIfc operatorDefinition;

  public Token(int startPosition, String value, TokenType type) {
    this(startPosition, value, type, null, null);
  }

  public Token(int startPosition, String value, TokenType type, FunctionIfc functionDefinition) {
    this(startPosition, value, type, functionDefinition, null);
  }

  public Token(int startPosition, String value, TokenType type, OperatorIfc operatorDefinition) {
    this(startPosition, value, type, null, operatorDefinition);
  }
}