]> gerrit.simantics Code Review - simantics/platform.git/blob - bundles/org.simantics.message/src/org/simantics/message/AbstractMessageSchemeHandler.java
Migrated source code from Simantics SVN
[simantics/platform.git] / bundles / org.simantics.message / src / org / simantics / message / AbstractMessageSchemeHandler.java
1 /*******************************************************************************\r
2  * Copyright (c) 2007, 2010 Association for Decentralized Information Management\r
3  * in Industry THTH ry.\r
4  * All rights reserved. This program and the accompanying materials\r
5  * are made available under the terms of the Eclipse Public License v1.0\r
6  * which accompanies this distribution, and is available at\r
7  * http://www.eclipse.org/legal/epl-v10.html\r
8  *\r
9  * Contributors:\r
10  *     VTT Technical Research Centre of Finland - initial API and implementation\r
11  *******************************************************************************/\r
12 package org.simantics.message;\r
13 \r
14 \r
15 /**\r
16  * Example usage:\r
17  * <pre>\r
18  * public class MyResourceSchemeHandler extends AbstractMessageSchemeHandler<MyResource> {\r
19  *     public MyResourceSchemeHandler() {\r
20  *         super("myresource", MyResource.class);\r
21  *     }\r
22  *     public void doPerform(MyResource r) {\r
23  *         // Do your stuff...\r
24  *     }\r
25  * }\r
26  * </pre>\r
27  * \r
28  * @author Tuukka Lehtonen\r
29  */\r
30 public abstract class AbstractMessageSchemeHandler<T> implements IMessageSchemeHandler {\r
31 \r
32     private String scheme;\r
33     private Class<?> expectedDataClass;\r
34     \r
35     public AbstractMessageSchemeHandler(String scheme, Class<?> expectedDataClass) {\r
36         this.scheme = scheme;\r
37         this.expectedDataClass = expectedDataClass;\r
38     }\r
39     \r
40     @Override\r
41     public String getScheme() {\r
42         return scheme;\r
43     }\r
44 \r
45     @SuppressWarnings("unchecked")\r
46     @Override\r
47     public void perform(Object o) throws MessageSchemeException {\r
48         if (expectedDataClass.isInstance(o)) {\r
49             doPerform((T) o);\r
50         } else {\r
51             handleInvalidData(o);\r
52         }\r
53     }\r
54 \r
55     public void handleInvalidData(Object o) {\r
56         // Override to handle differently\r
57         throw new RuntimeException("Object " + o + " is not an instance of " + expectedDataClass.getCanonicalName());\r
58     }\r
59 \r
60     public abstract void doPerform(T o) throws MessageSchemeException;\r
61 \r
62 }\r