com.udojava.evalex.AbstractLazyFunction 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 java.util.Locale;

/**
 * Abstract implementation of a lazy function which implements all necessary methods with the
 * exception of the main logic.
 */
public abstract class AbstractLazyFunction implements LazyFunction {

  /**
   * Name of this function.
   */
  protected String name;
  /**
   * Number of parameters expected for this function. -1 denotes a variable number of
   * parameters.
   */
  protected int numParams;

  /**
   * Whether this function is a boolean function.
   */
  protected boolean booleanFunction;

  /**
   * Creates a new function with given name and parameter count.
   *
   * @param name            The name of the function.
   * @param numParams       The number of parameters for this function.
   *                        -1 denotes a variable number of parameters.
   * @param booleanFunction Whether this function is a boolean function.
   */
  protected AbstractLazyFunction(String name, int numParams, boolean booleanFunction) {
    this.name = name.toUpperCase(Locale.ROOT);
    this.numParams = numParams;
    this.booleanFunction = booleanFunction;
  }

  /**
   * Creates a new function with given name and parameter count.
   *
   * @param name      The name of the function.
   * @param numParams The number of parameters for this function.
   *                  -1 denotes a variable number of parameters.
   */
  protected AbstractLazyFunction(String name, int numParams) {
    this(name, numParams, false);
  }

  public String getName() {
    return name;
  }

  public int getNumParams() {
    return numParams;
  }

  public boolean numParamsVaries() {
    return numParams < 0;
  }

  public boolean isBooleanFunction() {
    return booleanFunction;
  }
}