summaryrefslogtreecommitdiff
path: root/src/net/sourceforge/plantuml/evalex/Function.java
diff options
context:
space:
mode:
Diffstat (limited to 'src/net/sourceforge/plantuml/evalex/Function.java')
-rw-r--r--src/net/sourceforge/plantuml/evalex/Function.java47
1 files changed, 47 insertions, 0 deletions
diff --git a/src/net/sourceforge/plantuml/evalex/Function.java b/src/net/sourceforge/plantuml/evalex/Function.java
new file mode 100644
index 0000000..78d48d4
--- /dev/null
+++ b/src/net/sourceforge/plantuml/evalex/Function.java
@@ -0,0 +1,47 @@
+/*
+ * 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 net.sourceforge.plantuml.evalex;
+
+import java.math.BigDecimal;
+import java.util.List;
+
+/**
+ * Base interface which is required for all directly evaluated functions.
+ */
+public interface Function extends LazyFunction {
+
+ /**
+ * Implementation for this function.
+ *
+ * @param parameters
+ * Parameters will be passed by the expression evaluator as a
+ * {@link List} of {@link BigDecimal} values.
+ * @return The function must return a new {@link BigDecimal} value as a
+ * computing result.
+ */
+ public abstract BigDecimal eval(List<? extends Number> parameters);
+}