Migrated source code from Simantics SVN

[simantics/platform.git] / bundles / org.simantics.databoard / src / org / simantics / databoard / adapter / Adapter.java

diff --git a/bundles/org.simantics.databoard/src/org/simantics/databoard/adapter/Adapter.java b/bundles/org.simantics.databoard/src/org/simantics/databoard/adapter/Adapter.java
new file mode 100644 (file)
index 0000000..070d7de
--- /dev/null
+++ b/bundles/org.simantics.databoard/src/org/simantics/databoard/adapter/Adapter.java
@@ -0,0 +1,54 @@
+/*******************************************************************************\r
+ *  Copyright (c) 2010 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.adapter;
+
+import org.simantics.databoard.Bindings;\r
+
+/**
+ * Adapter converts one java class instance to another.
+ * 
+ * Use {@link Bindings#getAdapter(org.simantics.databoard.binding.Binding, org.simantics.databoard.binding.Binding)}
+ * to instantiate an adapter between bindings.
+ */
+public interface Adapter {
+
+    /**
+     * Adapt instance of one binding to format of another binding.
+     * 
+     * Note! adapt may recycle the argument (use it in the result).\r
+     * This dependes on the implementation. Cloning adapter recycles only\r
+     * immutable instances.
+     * 
+     * @param obj source instance
+     * @return result 
+     * @throws AdaptException 
+     */
+       public abstract Object adapt(Object obj)
+       throws AdaptException;\r
+       \r
+    /**\r
+     * Adapt instance of one binding to format of another binding.\r
+     * \r
+     * Note! adapt may recycle the argument (use it in the result).\r
+     * This dependes on the implementation. Cloning adapter recycles only\r
+     * immutable instances.\r
+     * \r
+     * @param obj source instance\r
+     * @return result \r
+     * @throws RuntimeAdaptException \r
+     */\r
+       public abstract Object adaptUnchecked(Object obj)\r
+       throws RuntimeAdaptException;\r
+       
+       
+}
+