Migrated source code from Simantics SVN

[simantics/platform.git] / bundles / org.simantics.message / src / org / simantics / message / AbstractMessageSchemeHandler.java

diff --git a/bundles/org.simantics.message/src/org/simantics/message/AbstractMessageSchemeHandler.java b/bundles/org.simantics.message/src/org/simantics/message/AbstractMessageSchemeHandler.java
new file mode 100644 (file)
index 0000000..53dc4e9
--- /dev/null
+++ b/bundles/org.simantics.message/src/org/simantics/message/AbstractMessageSchemeHandler.java
@@ -0,0 +1,62 @@
+/*******************************************************************************\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.message;\r
+\r
+\r
+/**\r
+ * Example usage:\r
+ * <pre>\r
+ * public class MyResourceSchemeHandler extends AbstractMessageSchemeHandler<MyResource> {\r
+ *     public MyResourceSchemeHandler() {\r
+ *         super("myresource", MyResource.class);\r
+ *     }\r
+ *     public void doPerform(MyResource r) {\r
+ *         // Do your stuff...\r
+ *     }\r
+ * }\r
+ * </pre>\r
+ * \r
+ * @author Tuukka Lehtonen\r
+ */\r
+public abstract class AbstractMessageSchemeHandler<T> implements IMessageSchemeHandler {\r
+\r
+    private String scheme;\r
+    private Class<?> expectedDataClass;\r
+    \r
+    public AbstractMessageSchemeHandler(String scheme, Class<?> expectedDataClass) {\r
+        this.scheme = scheme;\r
+        this.expectedDataClass = expectedDataClass;\r
+    }\r
+    \r
+    @Override\r
+    public String getScheme() {\r
+        return scheme;\r
+    }\r
+\r
+    @SuppressWarnings("unchecked")\r
+    @Override\r
+    public void perform(Object o) throws MessageSchemeException {\r
+        if (expectedDataClass.isInstance(o)) {\r
+            doPerform((T) o);\r
+        } else {\r
+            handleInvalidData(o);\r
+        }\r
+    }\r
+\r
+    public void handleInvalidData(Object o) {\r
+        // Override to handle differently\r
+        throw new RuntimeException("Object " + o + " is not an instance of " + expectedDataClass.getCanonicalName());\r
+    }\r
+\r
+    public abstract void doPerform(T o) throws MessageSchemeException;\r
+\r
+}\r