IFunctionLibrary.java

/*
 * Portions of this software was developed by employees of the National Institute
 * of Standards and Technology (NIST), an agency of the Federal Government and is
 * being made available as a public service. Pursuant to title 17 United States
 * Code Section 105, works of NIST employees are not subject to copyright
 * protection in the United States. This software may be subject to foreign
 * copyright. Permission in the United States and in foreign countries, to the
 * extent that NIST may hold copyright, to use, copy, modify, create derivative
 * works, and distribute this software and its documentation without fee is hereby
 * granted on a non-exclusive basis, provided that this notice and disclaimer
 * of warranty appears in all copies.
 *
 * THE SOFTWARE IS PROVIDED 'AS IS' WITHOUT ANY WARRANTY OF ANY KIND, EITHER
 * EXPRESSED, IMPLIED, OR STATUTORY, INCLUDING, BUT NOT LIMITED TO, ANY WARRANTY
 * THAT THE SOFTWARE WILL CONFORM TO SPECIFICATIONS, ANY IMPLIED WARRANTIES OF
 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, AND FREEDOM FROM
 * INFRINGEMENT, AND ANY WARRANTY THAT THE DOCUMENTATION WILL CONFORM TO THE
 * SOFTWARE, OR ANY WARRANTY THAT THE SOFTWARE WILL BE ERROR FREE.  IN NO EVENT
 * SHALL NIST BE LIABLE FOR ANY DAMAGES, INCLUDING, BUT NOT LIMITED TO, DIRECT,
 * INDIRECT, SPECIAL OR CONSEQUENTIAL DAMAGES, ARISING OUT OF, RESULTING FROM,
 * OR IN ANY WAY CONNECTED WITH THIS SOFTWARE, WHETHER OR NOT BASED UPON WARRANTY,
 * CONTRACT, TORT, OR OTHERWISE, WHETHER OR NOT INJURY WAS SUSTAINED BY PERSONS OR
 * PROPERTY OR OTHERWISE, AND WHETHER OR NOT LOSS WAS SUSTAINED FROM, OR AROSE OUT
 * OF THE RESULTS OF, OR USE OF, THE SOFTWARE OR SERVICES PROVIDED HEREUNDER.
 */

package gov.nist.secauto.metaschema.core.metapath.function;

import gov.nist.secauto.metaschema.core.metapath.IExpression;

import java.util.List;
import java.util.stream.Stream;

import javax.xml.namespace.QName;

import edu.umd.cs.findbugs.annotations.NonNull;

public interface IFunctionLibrary {

  /**
   * Retrieve the collection of function signatures in this library as a stream.
   *
   * @return a stream of function signatures
   */
  @NonNull
  Stream<IFunction> getFunctionsAsStream();

  /**
   * Determine if there is a function with the provided name that supports the
   * signature of the provided methods.
   *
   * @param name
   *          the name of a group of functions
   * @param arguments
   *          a list of argument expressions for use in determining an argument
   *          signature match
   * @return {@code true} if a function signature matches or {@code false}
   *         otherwise
   */
  default boolean hasFunction(@NonNull String name, @NonNull List<IExpression> arguments) {
    return getFunction(name, arguments) != null;
  }

  /**
   * Determine if there is a function with the provided namespace qualified name
   * that supports the signature of the provided methods.
   *
   * @param name
   *          the namespace qualified name of a group of functions
   * @param arguments
   *          a list of argument expressions for use in determining an argument
   *          signature match
   * @return {@code true} if a function signature matches or {@code false}
   *         otherwise
   */
  default boolean hasFunction(@NonNull QName name, @NonNull List<IExpression> arguments) {
    return getFunction(name, arguments) != null;
  }

  /**
   * Retrieve the function with the provided name that supports the signature of
   * the provided methods, if such a function exists.
   *
   * @param name
   *          the name of a group of functions
   * @param arguments
   *          a list of argument expressions for use in determining an argument
   *          signature match
   * @return the matching function or {@code null} if no match exists
   */
  IFunction getFunction(@NonNull String name, @NonNull List<IExpression> arguments);

  /**
   * Retrieve the function with the provided namespace qualified name that
   * supports the signature of the provided methods, if such a function exists.
   *
   * @param name
   *          the namespace qualified name of a group of functions
   * @param arguments
   *          a list of argument expressions for use in determining an argument
   *          signature match
   * @return the matching function or {@code null} if no match exists
   */
  IFunction getFunction(@NonNull QName name, @NonNull List<IExpression> arguments);
}