Migrated source code from Simantics SVN

[simantics/platform.git] / bundles / org.simantics.db.common / src / org / simantics / db / common / provider / ResourceProvider.java

diff --git a/bundles/org.simantics.db.common/src/org/simantics/db/common/provider/ResourceProvider.java b/bundles/org.simantics.db.common/src/org/simantics/db/common/provider/ResourceProvider.java
new file mode 100644 (file)
index 0000000..acc97de
--- /dev/null
+++ b/bundles/org.simantics.db.common/src/org/simantics/db/common/provider/ResourceProvider.java
@@ -0,0 +1,43 @@
+/*******************************************************************************\r
+ * Copyright (c) 2007, 2010 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
+ *     VTT Technical Research Centre of Finland - initial API and implementation\r
+ *******************************************************************************/\r
+package org.simantics.db.common.provider;\r
+\r
+import org.simantics.db.ReadGraph;\r
+import org.simantics.db.Resource;\r
+\r
+/**\r
+ * An interface for externalizing the logic of retrieving an arbitrary resource\r
+ * for some purpose.\r
+ * \r
+ * <p>\r
+ * A {@link ReadGraph} is provided to allow implementations to browse the graph\r
+ * in order to retrieve a resource.\r
+ * </p>\r
+ * \r
+ * <p>\r
+ * This interface has an asynchronously operating counterpart, {@link AsyncResourceProvider}.\r
+ * </p>\r
+ * \r
+ * @see ResourceProviders\r
+ * @see AsyncResourceProvider\r
+ * \r
+ * @author Tuukka Lehtonen\r
+ */\r
+public interface ResourceProvider {\r
+\r
+    /**\r
+     * @param graph a graph for retrieving the resource to return\r
+     * @return the provided resource\r
+     */\r
+    Resource get(ReadGraph graph);\r
+\r
+}\r