com.udojava.evalex.LazyOperator 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 simple mathematical and boolean expressions.

The newest version!

/*
 * Copyright 2018 Udo Klimaschewski
 *
 * http://UdoJava.com/
 * http://about.me/udo.klimaschewski
 *
 * Permission is hereby granted, free of charge, to any person obtaining
 * a copy of this software and associated documentation files (the
 * "Software"), to deal in the Software without restriction, including
 * without limitation the rights to use, copy, modify, merge, publish,
 * distribute, sublicense, and/or sell copies of the Software, and to
 * permit persons to whom the Software is furnished to do so, subject to
 * the following conditions:
 *
 * The above copyright notice and this permission notice shall be
 * included in all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
 * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
 * OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
 * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 *
 */
package com.udojava.evalex;

import com.udojava.evalex.Expression.LazyNumber;

/**
 * Base interface which is required for all operators.
 */
public interface LazyOperator {


  /**
   * Gets the String that is used to denote the operator in the expression.
   *
   * @return The String that is used to denote the operator in the expression.
   */
  String getOper();


  /**
   * Gets the precedence value of this operator.
   *
   * @return the precedence value of this operator.
   */
  int getPrecedence();


  /**
   * Gets whether this operator is left associative (true) or if this operator is right
   * associative (false).
   *
   * @return true if this operator is left associative.
   */
  boolean isLeftAssoc();


  /**
   * Gets whether this operator evaluates to a boolean expression.
   *
   * @return true if this operator evaluates to a boolean
   * expression.
   */
  boolean isBooleanOperator();


  /**
   * Gets whether this operator is unary or not.
   *
   * @return true if this operator expects 1 operand, otherwise
   * false if this operator expects 2 operands.
   */
  boolean isUnaryOperator();


  /**
   * Implementation for this operator.
   *
   * @param v1 Operand 1.
   * @param v2 Operand 2.
   * @return The result of the operation.
   */
  LazyNumber eval(LazyNumber v1, LazyNumber v2);
}