]> gerrit.simantics Code Review - simantics/platform.git/blobdiff - bundles/org.simantics.utils.datastructures/src/org/simantics/utils/datastructures/hints/IHintStack.java
Fixed all line endings of the repository
[simantics/platform.git] / bundles / org.simantics.utils.datastructures / src / org / simantics / utils / datastructures / hints / IHintStack.java
index 16e3c42ea4f68a679f722159c61462f977772449..9fc3ab7cbfdde8e4f43bf2bc563ef00fec0a1672 100644 (file)
@@ -1,50 +1,50 @@
-/*******************************************************************************\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
-/*\r
- *\r
- * @author Toni Kalajainen\r
- */\r
-package org.simantics.utils.datastructures.hints;\r
-\r
-\r
-/**\r
- * IHintStack is a layered stack of hint contexts.  \r
- * Each hint context has a priority. \r
- * Hint set in higher priority context overrides all lower priority hints of \r
- * the same key.\r
- * \r
- * Hint set in a hint context does not become effective if there \r
- * exists another hint of the same key in a higher priority context. \r
- * \r
- * If the higher priority context or its hint is removed, the next lower level hint\r
- * becomes effective.\r
- * \r
- * getHint() method is global. It returns the highest priority value for the key.\r
- * It does not return the hint set for a specific context, instead it returns the hint\r
- * set in the highest priority context.  \r
- */\r
-public interface IHintStack extends IHintObservable {\r
-\r
-       void addHintContext(IHintContext hints, int priority);\r
-       \r
-       boolean removeHintContext(IHintContext hints);\r
-       \r
-       /**\r
-        * Returns a wrapper hint context whose read operations originate from the stack, and\r
-        * write operations to the a local stack (argument ctx)\r
-        * \r
-     * @param ctx the hint context to write into\r
-     * @return write-localized hint context based on this hint stack\r
-        */\r
-       IHintContext createStackRead(final IHintContext ctx);   \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
+ *******************************************************************************/
+/*
+ *
+ * @author Toni Kalajainen
+ */
+package org.simantics.utils.datastructures.hints;
+
+
+/**
+ * IHintStack is a layered stack of hint contexts.  
+ * Each hint context has a priority. 
+ * Hint set in higher priority context overrides all lower priority hints of 
+ * the same key.
+ * 
+ * Hint set in a hint context does not become effective if there 
+ * exists another hint of the same key in a higher priority context. 
+ * 
+ * If the higher priority context or its hint is removed, the next lower level hint
+ * becomes effective.
+ * 
+ * getHint() method is global. It returns the highest priority value for the key.
+ * It does not return the hint set for a specific context, instead it returns the hint
+ * set in the highest priority context.  
+ */
+public interface IHintStack extends IHintObservable {
+
+       void addHintContext(IHintContext hints, int priority);
+       
+       boolean removeHintContext(IHintContext hints);
+       
+       /**
+        * Returns a wrapper hint context whose read operations originate from the stack, and
+        * write operations to the a local stack (argument ctx)
+        * 
+     * @param ctx the hint context to write into
+     * @return write-localized hint context based on this hint stack
+        */
+       IHintContext createStackRead(final IHintContext ctx);   
+       
+}