001/* 002 * Portions of this software was developed by employees of the National Institute 003 * of Standards and Technology (NIST), an agency of the Federal Government and is 004 * being made available as a public service. Pursuant to title 17 United States 005 * Code Section 105, works of NIST employees are not subject to copyright 006 * protection in the United States. This software may be subject to foreign 007 * copyright. Permission in the United States and in foreign countries, to the 008 * extent that NIST may hold copyright, to use, copy, modify, create derivative 009 * works, and distribute this software and its documentation without fee is hereby 010 * granted on a non-exclusive basis, provided that this notice and disclaimer 011 * of warranty appears in all copies. 012 * 013 * THE SOFTWARE IS PROVIDED 'AS IS' WITHOUT ANY WARRANTY OF ANY KIND, EITHER 014 * EXPRESSED, IMPLIED, OR STATUTORY, INCLUDING, BUT NOT LIMITED TO, ANY WARRANTY 015 * THAT THE SOFTWARE WILL CONFORM TO SPECIFICATIONS, ANY IMPLIED WARRANTIES OF 016 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, AND FREEDOM FROM 017 * INFRINGEMENT, AND ANY WARRANTY THAT THE DOCUMENTATION WILL CONFORM TO THE 018 * SOFTWARE, OR ANY WARRANTY THAT THE SOFTWARE WILL BE ERROR FREE. IN NO EVENT 019 * SHALL NIST BE LIABLE FOR ANY DAMAGES, INCLUDING, BUT NOT LIMITED TO, DIRECT, 020 * INDIRECT, SPECIAL OR CONSEQUENTIAL DAMAGES, ARISING OUT OF, RESULTING FROM, 021 * OR IN ANY WAY CONNECTED WITH THIS SOFTWARE, WHETHER OR NOT BASED UPON WARRANTY, 022 * CONTRACT, TORT, OR OTHERWISE, WHETHER OR NOT INJURY WAS SUSTAINED BY PERSONS OR 023 * PROPERTY OR OTHERWISE, AND WHETHER OR NOT LOSS WAS SUSTAINED FROM, OR AROSE OUT 024 * OF THE RESULTS OF, OR USE OF, THE SOFTWARE OR SERVICES PROVIDED HEREUNDER. 025 */ 026 027package gov.nist.secauto.metaschema.core.metapath.function; 028 029import gov.nist.secauto.metaschema.core.metapath.IExpression; 030 031import java.util.List; 032import java.util.stream.Stream; 033 034import javax.xml.namespace.QName; 035 036import edu.umd.cs.findbugs.annotations.NonNull; 037 038public interface IFunctionLibrary { 039 040 /** 041 * Retrieve the collection of function signatures in this library as a stream. 042 * 043 * @return a stream of function signatures 044 */ 045 @NonNull 046 Stream<IFunction> getFunctionsAsStream(); 047 048 /** 049 * Determine if there is a function with the provided name that supports the 050 * signature of the provided methods. 051 * 052 * @param name 053 * the name of a group of functions 054 * @param arguments 055 * a list of argument expressions for use in determining an argument 056 * signature match 057 * @return {@code true} if a function signature matches or {@code false} 058 * otherwise 059 */ 060 default boolean hasFunction(@NonNull String name, @NonNull List<IExpression> arguments) { 061 return getFunction(name, arguments) != null; 062 } 063 064 /** 065 * Determine if there is a function with the provided namespace qualified name 066 * that supports the signature of the provided methods. 067 * 068 * @param name 069 * the namespace qualified name of a group of functions 070 * @param arguments 071 * a list of argument expressions for use in determining an argument 072 * signature match 073 * @return {@code true} if a function signature matches or {@code false} 074 * otherwise 075 */ 076 default boolean hasFunction(@NonNull QName name, @NonNull List<IExpression> arguments) { 077 return getFunction(name, arguments) != null; 078 } 079 080 /** 081 * Retrieve the function with the provided name that supports the signature of 082 * the provided methods, if such a function exists. 083 * 084 * @param name 085 * the name of a group of functions 086 * @param arguments 087 * a list of argument expressions for use in determining an argument 088 * signature match 089 * @return the matching function or {@code null} if no match exists 090 */ 091 IFunction getFunction(@NonNull String name, @NonNull List<IExpression> arguments); 092 093 /** 094 * Retrieve the function with the provided namespace qualified name that 095 * supports the signature of the provided methods, if such a function exists. 096 * 097 * @param name 098 * the namespace qualified name of a group of functions 099 * @param arguments 100 * a list of argument expressions for use in determining an argument 101 * signature match 102 * @return the matching function or {@code null} if no match exists 103 */ 104 IFunction getFunction(@NonNull QName name, @NonNull List<IExpression> arguments); 105}