]> gerrit.simantics Code Review - simantics/platform.git/blobdiff - bundles/org.simantics.scenegraph/src/org/simantics/scenegraph/ILookupService.java
Fixed all line endings of the repository
[simantics/platform.git] / bundles / org.simantics.scenegraph / src / org / simantics / scenegraph / ILookupService.java
index 55548682fe26809fbcfc618fd8d2f63b3dacd90d..25c1663b5875ae6ea45e5533d5d24d33582d7201 100644 (file)
@@ -1,68 +1,68 @@
-/*******************************************************************************\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.scenegraph;\r
-\r
-/**\r
- * A bijective mapping service between unique String ID's and scene graph nodes\r
- * ({@link INode}).\r
- * \r
- * @author Tuukka Lehtonen\r
- */\r
-public interface ILookupService {\r
-\r
-    /**\r
-     * Associates the specified node with the specified ID. If the specified ID\r
-     * is already associated the previous association will be overwritten with\r
-     * the new one and the previously associated node is returned.\r
-     * \r
-     * @param id the id to map to the specified node\r
-     * @param node node to map to specified id\r
-     * @return the node previously associated with the specified ID or\r
-     *         <code>null</code> if the specified ID no previous association\r
-     * @throws NullPointerException if either argument is <code>null</code>\r
-     */\r
-    INode map(String id, INode node);\r
-\r
-    /**\r
-     * Removes possibly existing ID <=> node mapping from the lookup service.\r
-     * \r
-     * @param id the id to unmap\r
-     * @return the unmapped INode if successful, <code>null</code> otherwise\r
-     */\r
-    INode unmap(String id);\r
-\r
-    /**\r
-     * Removes possibly existing node <=> ID mapping from the lookup service.\r
-     * \r
-     * @param node the node to unmap\r
-     * @return the unmapped ID if successful, <code>null</code> otherwise\r
-     */\r
-    String unmap(INode node);\r
-\r
-    /**\r
-     * Get the node mapped to the specified ID.\r
-     * \r
-     * @param id identifier of the node to look for\r
-     * @return node mapped with specified id or <code>null</code> if no mapping\r
-     *         exists\r
-     */\r
-    INode lookupNode(String id);\r
-\r
-    /**\r
-     * Get the mapping ID for the specified node.\r
-     * \r
-     * @param node node to get mapping ID for\r
-     * @return mapping ID of the node or <code>null</code> if node is not mapped\r
-     */\r
-    String lookupId(INode node);\r
-\r
-}\r
+/*******************************************************************************
+ * Copyright (c) 2007, 2010 Association for Decentralized Information Management
+ * in Industry THTH ry.
+ * All rights reserved. This program and the accompanying materials
+ * are made available under the terms of the Eclipse Public License v1.0
+ * which accompanies this distribution, and is available at
+ * http://www.eclipse.org/legal/epl-v10.html
+ *
+ * Contributors:
+ *     VTT Technical Research Centre of Finland - initial API and implementation
+ *******************************************************************************/
+package org.simantics.scenegraph;
+
+/**
+ * A bijective mapping service between unique String ID's and scene graph nodes
+ * ({@link INode}).
+ * 
+ * @author Tuukka Lehtonen
+ */
+public interface ILookupService {
+
+    /**
+     * Associates the specified node with the specified ID. If the specified ID
+     * is already associated the previous association will be overwritten with
+     * the new one and the previously associated node is returned.
+     * 
+     * @param id the id to map to the specified node
+     * @param node node to map to specified id
+     * @return the node previously associated with the specified ID or
+     *         <code>null</code> if the specified ID no previous association
+     * @throws NullPointerException if either argument is <code>null</code>
+     */
+    INode map(String id, INode node);
+
+    /**
+     * Removes possibly existing ID <=> node mapping from the lookup service.
+     * 
+     * @param id the id to unmap
+     * @return the unmapped INode if successful, <code>null</code> otherwise
+     */
+    INode unmap(String id);
+
+    /**
+     * Removes possibly existing node <=> ID mapping from the lookup service.
+     * 
+     * @param node the node to unmap
+     * @return the unmapped ID if successful, <code>null</code> otherwise
+     */
+    String unmap(INode node);
+
+    /**
+     * Get the node mapped to the specified ID.
+     * 
+     * @param id identifier of the node to look for
+     * @return node mapped with specified id or <code>null</code> if no mapping
+     *         exists
+     */
+    INode lookupNode(String id);
+
+    /**
+     * Get the mapping ID for the specified node.
+     * 
+     * @param node node to get mapping ID for
+     * @return mapping ID of the node or <code>null</code> if node is not mapped
+     */
+    String lookupId(INode node);
+
+}