Migrated source code from Simantics SVN

[simantics/platform.git] / bundles / org.simantics.db / src / org / simantics / db / function / DbConsumer.java

diff --git a/bundles/org.simantics.db/src/org/simantics/db/function/DbConsumer.java b/bundles/org.simantics.db/src/org/simantics/db/function/DbConsumer.java
new file mode 100644 (file)
index 0000000..6e37bb5
--- /dev/null
+++ b/bundles/org.simantics.db/src/org/simantics/db/function/DbConsumer.java
@@ -0,0 +1,62 @@
+/*******************************************************************************\r
+ * Copyright (c) 2016 Association for Decentralized Information Management\r
+ * in Industry THTH ry.\r
+ * All rights reserved. This program and the accompanying materials\r
+ * are made available under the terms of the Eclipse Public License v1.0\r
+ * which accompanies this distribution, and is available at\r
+ * http://www.eclipse.org/legal/epl-v10.html\r
+ *\r
+ * Contributors:\r
+ *     Semantum Oy - initial API and implementation\r
+ *******************************************************************************/\r
+package org.simantics.db.function;\r
+\r
+import java.util.Objects;\r
+import java.util.function.Consumer;\r
+\r
+import org.simantics.db.exception.DatabaseException;\r
+\r
+/**\r
+ * Represents a database operation that accepts a single input argument and\r
+ * returns no result and can throw database exceptions. Unlike most other\r
+ * functional interfaces, {@code DbConsumer} is expected to operate via\r
+ * side-effects.\r
+ *\r
+ * <p>\r
+ * This is a functional interface whose functional method is\r
+ * {@link #accept(Object)}. The only difference to {@link Consumer} is that this\r
+ * allows throwing DatabaseException.\r
+ *\r
+ * @param <T>\r
+ *            the type of the input to the operation\r
+ *\r
+ * @author Tuukka Lehtonen\r
+ * @since 1.22\r
+ */\r
+@FunctionalInterface\r
+public interface DbConsumer<T> {\r
+\r
+    /**\r
+     * Performs this operation on the given argument.\r
+     *\r
+     * @param t the input argument\r
+     */\r
+    void accept(T t) throws DatabaseException;\r
+\r
+    /**\r
+     * Returns a composed {@code Consumer} that performs, in sequence, this\r
+     * operation followed by the {@code after} operation. If performing either\r
+     * operation throws an exception, it is relayed to the caller of the\r
+     * composed operation.  If performing this operation throws an exception,\r
+     * the {@code after} operation will not be performed.\r
+     *\r
+     * @param after the operation to perform after this operation\r
+     * @return a composed {@code Consumer} that performs in sequence this\r
+     * operation followed by the {@code after} operation\r
+     * @throws NullPointerException if {@code after} is null\r
+     */\r
+    default DbConsumer<T> andThen(DbConsumer<? super T> after) {\r
+        Objects.requireNonNull(after);\r
+        return (T t) -> { accept(t); after.accept(t); };\r
+    }\r
+}\r