blob: b33919d306509b8843817873aecb2a984f707294 (
plain) (
blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
|
/*****************************************************************************
* Copyright (c) 2010, 2016 CEA LIST, Christian W. Damus, and others.
*
* 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:
* Camille Letavernier (CEA LIST) camille.letavernier@cea.fr - Initial API and implementation
* Christian W. Damus - bug 485220
*
*****************************************************************************/
package org.eclipse.papyrus.infra.constraints.constraints;
import java.util.Collection;
import org.eclipse.papyrus.infra.constraints.ConstraintDescriptor;
import org.eclipse.papyrus.infra.constraints.DisplayUnit;
/**
* An interface representing a Constraint. A Constraint is used to test if a selection
* is matching a pre-configured property view.
*
* @author Camille Letavernier
*
*/
public interface Constraint {
/**
* Sets the Constraint Descriptor for this constraint.
* The constraint descriptor may contain some parameters to configure this
* constraint
*
* @param descriptor
* The constraint descriptor to be associated to this constraint
*/
public void setConstraintDescriptor(ConstraintDescriptor descriptor);
/**
* Tests if this constraint matches the given selection
*
* @param selection
* The selection to be tested against this constraint
* @return
* True if this constraint matches the given selection
*/
public boolean match(Collection<?> selection);
/**
* Returns the view associated to this constraint, or null if the constraint is associated to another
* kind of display unit (e.g. a section)
*
* @return
* The view associated to this constraint
*/
public DisplayUnit getDisplayUnit();
/**
* Tests if this constraint should override the given constraint. If true,
* the other constraint's display unit won't be displayed. A constraint should
* never override itself, and you should ensure that there are no loops in the
* constraint overriding graph. If such a loops occurs, nothing will be displayed
*
* @param constraint
* The tested constraint
* @return
* True if this constraint overrides the given constraint
*/
public boolean overrides(Constraint constraint);
/**
* @return the constraint descriptor associated to this constraint
*/
public ConstraintDescriptor getDescriptor();
}
|
