Package: ECPStringModifier

ECPStringModifier

Coverage

1: /*******************************************************************************
2: * Copyright (c) 2011-2014 EclipseSource Muenchen GmbH and others.
3: *
4: * All rights reserved. This program and the accompanying materials
5: * are made available under the terms of the Eclipse Public License 2.0
6: * which accompanies this distribution, and is available at
7: * https://www.eclipse.org/legal/epl-2.0/
8: *
9: * SPDX-License-Identifier: EPL-2.0
10: *
11: * Contributors:
12: * Eugen - initial API and implementation
13: * Johannes Faltermeier - Bug 459998
14: ******************************************************************************/
15: package org.eclipse.emf.ecp.view.spi.provider;
16:
17: import org.eclipse.emf.ecore.EStructuralFeature.Setting;
18:
19: /**
20: * The TooltipModifier allows to manipulate a provided String.
21: *
22: * @author Eugen Neufeld
23: * @author Johannes Faltermeier
24: * @since 1.3
25: */
26: public interface ECPStringModifier {
27:
28:         /**
29:          * Modifies a string.
30:          *
31:          * @param text the text to modify
32:          * @param setting the Setting used to generate this text
33:          * @return the modified text
34:          */
35:         String modifyString(String text, Setting setting);
36:
37:         /**
38:          * Returns the priority of this modifier. A lower priority means that the {@link #modifyString(String, Setting)}
39:          * method of this modifier is executed before modifiers with higher priority.
40:          *
41:          * @return the priority
42:          *
43:          * @since 1.7
44:          */
45:         double getPriority();
46: }