X-Git-Url: https://gerrit.simantics.org/r/gitweb?a=blobdiff_plain;f=bundles%2Forg.simantics.utils.datastructures%2Fsrc%2Forg%2Fsimantics%2Futils%2Fdatastructures%2Fhints%2FIHintStack.java;fp=bundles%2Forg.simantics.utils.datastructures%2Fsrc%2Forg%2Fsimantics%2Futils%2Fdatastructures%2Fhints%2FIHintStack.java;h=9fc3ab7cbfdde8e4f43bf2bc563ef00fec0a1672;hb=0ae2b770234dfc3cbb18bd38f324125cf0faca07;hp=16e3c42ea4f68a679f722159c61462f977772449;hpb=24e2b34260f219f0d1644ca7a138894980e25b14;p=simantics%2Fplatform.git diff --git a/bundles/org.simantics.utils.datastructures/src/org/simantics/utils/datastructures/hints/IHintStack.java b/bundles/org.simantics.utils.datastructures/src/org/simantics/utils/datastructures/hints/IHintStack.java index 16e3c42ea..9fc3ab7cb 100644 --- a/bundles/org.simantics.utils.datastructures/src/org/simantics/utils/datastructures/hints/IHintStack.java +++ b/bundles/org.simantics.utils.datastructures/src/org/simantics/utils/datastructures/hints/IHintStack.java @@ -1,50 +1,50 @@ -/******************************************************************************* - * 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); - -} +/******************************************************************************* + * 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); + +}