Migrated source code from Simantics SVN

[simantics/platform.git] / bundles / org.simantics.databoard / src / org / simantics / databoard / binding / reflection / BindingProvider.java

diff --git a/bundles/org.simantics.databoard/src/org/simantics/databoard/binding/reflection/BindingProvider.java b/bundles/org.simantics.databoard/src/org/simantics/databoard/binding/reflection/BindingProvider.java
new file mode 100644 (file)
index 0000000..f152803
--- /dev/null
+++ b/bundles/org.simantics.databoard/src/org/simantics/databoard/binding/reflection/BindingProvider.java
@@ -0,0 +1,41 @@
+/*******************************************************************************\r
+ * Copyright (c) 2007, 2011 Association for Decentralized Information Management in\r
+ * 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.databoard.binding.reflection;\r
+\r
+import org.simantics.databoard.binding.Binding;\r
+import org.simantics.databoard.binding.error.BindingConstructionException;\r
+\r
+/**\r
+ * Binding provider is an interface for providers that provide context-specific\r
+ * or hand-written bindings for the whole binding construction mechanism.\r
+ *\r
+ * @author toni.kalajainen@semantum.fi\r
+ */\r
+public interface BindingProvider {\r
+\r
+       /**\r
+        * Construct a binding for a request. This method returns null if a binding\r
+        * cannot be provided by this factory. Exception is thrown if construction\r
+        * is expected to success but fails for a reason.\r
+        *  \r
+        * If this class constructs a compositive type: Array, Map, Optional, \r
+        * Record or Union, the composite types/fields need not be filled, and \r
+        * should be left null. They are filled by the caller.  \r
+        * \r
+        * @param request\r
+        * @param mainFactory master factory\r
+        * @return binding or <code>null</code> \r
+        * @throws BindingConstructionException\r
+        */\r
+       Binding provideBinding(ClassBindingFactory mainFactory, BindingRequest request) throws BindingConstructionException;\r
+       \r
+}\r