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
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
|
/*****************************************************************************
* Copyright (c) 2011, 2015, 2018 CEA LIST, Christian W. Damus, EclipseSource 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:
* CEA LIST - Initial API and implementation
* Christian W. Damus - bug 465899
* Bonnabesse Fanch (ALL4TEC) fanch.bonnabesse@alltec.net - Bug 476872
* Vincent Lorenzo (CEA LIST) vincent.lorenzo@cea.fr - bug 492522
* Vincent Lorenzo (CEA LIST) vincent.lorenzo@cea.fr - bug 530026
* EclipseSource - Bug 533678
*****************************************************************************/
package org.eclipse.papyrus.infra.services.edit.utils;
import org.eclipse.gmf.runtime.emf.type.core.requests.CreateRelationshipRequest;
import org.eclipse.gmf.runtime.emf.type.core.requests.IEditCommandRequest;
import com.google.common.base.Defaults;
/**
* <pre>
* IDs of request parameters.
* </pre>
*/
public interface RequestParameterConstants {
/**
* The ID for the additional parameter SOURCE_PARENT possibly required in link creation request
*
* @deprecated
*/
@Deprecated
public static final String CONNECTOR_CREATE_REQUEST_SOURCE_PARENT = "SOURCE_PARENT"; //$NON-NLS-1$
/**
* The ID for the additional parameter TARGET_PARENT possibly required in link creation request
*
* @deprecated
*/
@Deprecated
public static final String CONNECTOR_CREATE_REQUEST_TARGET_PARENT = "TARGET_PARENT"; //$NON-NLS-1$
/**
* The ID for the additional parameter RECONNECT_PARENT possibly required in link reconnect request
*
* @deprecated
*/
@Deprecated
public static final String CONNECTOR_REORIENT_REQUEST_TARGET_PARENT = "RECONNECT_PARENT"; //$NON-NLS-1$
/**
* Extended request data key to hold the edge view during a reconnect request.
*/
public static final String GRAPHICAL_RECONNECTED_EDGE = "graphical_edge"; //$NON-NLS-1$
/**
* The ID for the additional parameter SOURCE_GRAPHICAL_VIEW possibly required in link creation request
*/
public static final String EDGE_CREATE_REQUEST_SOURCE_VIEW = "SOURCE_GRAPHICAL_VIEW"; //$NON-NLS-1$
/**
* The ID for the additional parameter TARGET_GRAPHICAL_VIEW possibly required in link creation request
*/
public static final String EDGE_CREATE_REQUEST_TARGET_VIEW = "TARGET_GRAPHICAL_VIEW"; //$NON-NLS-1$
/**
* The ID for the additional parameter RECONNECT_END_VIEW possibly required in link reconnect request
*/
public static final String EDGE_REORIENT_REQUEST_END_VIEW = "RECONNECT_END_VIEW"; //$NON-NLS-1$
/**
* The ID to store the list of element under re-factoring.
*/
public static final String ASSOCIATION_REFACTORED_ELEMENTS = "ASSOCIATION_REFACTORED_ELEMENTS"; //$NON-NLS-1$
/**
* The ID to store the list of element that should not be destroyed (avoid dependents destroy).
*/
public static final String DEPENDENTS_TO_KEEP = "DEPENDENTS_TO_KEEP"; //$NON-NLS-1$
/**
* The ID to store the source figure for an edge creation
*/
public static final String EDGE_SOURCE_FIGURE = "EDGE_SOURCE_FIGURE"; //$NON-NLS-1$
/**
* The ID to store the target figure for an edge creation
*/
public static final String EDGE_TARGET_FIGURE = "EDGE_TARGET_FIGURE"; //$NON-NLS-1$
/**
* the ID to store the source point for an edge creation
*/
public static final String EDGE_SOURCE_POINT = "EDGE_SOURCE_POINT"; //$NON-NLS-1$
/**
* the ID to store the target point for an edge creation
*/
public static final String EDGE_TARGET_POINT = "EDGE_TARGET_POINT"; //$NON-NLS-1$
/**
* the ID to enable transactional nesting for the used command in edit helper.
*/
public static final String TRANSACTIONAL_NESTING = "TRANSACTIONAL_NESTING"; //$NON-NLS-1$
/**
* the ID to store the name to be set for the new element.
*/
public static final String NAME_TO_SET = "nameToSet"; //$NON-NLS-1$
/**
* indicates the string to take to build the name of the new element (typically, we will increments the provided string)
* if the value of the parameter can't be null. If the string is empty, the new element won't be named
*
* @since 3.0
*/
public static final String BASE_NAME_TO_SET = "baseNameToSet"; //$NON-NLS-1$
/**
* the ID to store the visual id of the view on which we are working, the value must be a string
*/
public static final String VIEW_VISUAL_ID = "VISUAL_ID";//$NON-NLS-1$
/**
* this constant is used to precise if it is needed to launch UI during the edition of an element
*/
public static String USE_GUI = "USE_GUI"; //$NON-NLS-1$
/**
* A boolean-valued parameter for {@link CreateRelationshipRequest} that indicates
* whether the creation of the relationship will modify the source element (usually
* because it will have an inverse reference to some element of the relationship).
* The default value is {@code true} if the parameter is not specified. <b>Note</b>
* that this is different from the {@link #AFFECTS_TARGET} parameter.
*
* @see #AFFECTS_TARGET
*/
public static final String AFFECTS_SOURCE = "papyrus.affectsSource"; //$NON-NLS-1$
/**
* A boolean-valued parameter for {@link CreateRelationshipRequest} that indicates
* whether the creation of the relationship will modify the target element (usually
* because it will have an inverse reference to some element of the relationship).
* The default value is {@code false} if the parameter is not specified. <b>Note</b>
* that this is different from the {@link #AFFECTS_SOURCE} parameter.
*
* @see #AFFECTS_SOURCE
*/
public static final String AFFECTS_TARGET = "papyrus.affectsTarget"; //$NON-NLS-1$
/**
* Constant used to indicate that the action is done on the diagram.
*/
public static final String TYPE_MOVING_DIAGRAM = "TYPE_MOVING_DIAGRAM"; //$NON-NLS-1$
/**
* Constant used to indicate where the action is done.
*/
public static final String TYPE_MOVING = "TYPE_MOVING"; //$NON-NLS-1$
/**
* Store the view on which we are working.
*/
public static final String AFFECTED_VIEW = "AFFECTED_VIEW";//$NON-NLS-1$
/**
* this constant is used to precise if it is needed to make the editdialog cancellable or not
*/
public static String DIALOG_CANCELLABLE = "DIALOG_CANCELLABLE"; //$NON-NLS-1$
/**
* <p>
* Parameter used to create a new element at the given index. The value must be
* an {@link Integer}.
* </p>
* <p>
* A Value lower than 0 means that the element should be inserted at the end of the list. This is equivalent
* to not specifying the parameter at all, and is the default behavior.
* </p>
* <p>
* <code>Note:</code> In general, <strong>this parameter is unsupported</strong>; it is only used in a few specific cases.
* If used outside of these few supported cases, the parameter will be ignored.
* </p>
*
* @since 3.1
*/
public static final String INSERT_AT = "InsertAt"; //$NON-NLS-1$
//
// Nested types
//
/**
* Provider of default values for request parameters that support them, defined in the
* {@link RequestParameterConstants} type.
*/
final class DefaultValues {
/**
* Obtains the value of a parameter of the given {@code type} from a {@code request},
* returning the parameter's default value (if any such is defined) in the case that it
* is absent from the request.
*
* @param request
* an edit request
* @param parameterName
* the name of the parameter to retrieve
* @param type
* the type of the parameter
*
* @return the parameter value, its default (if specified) in case it is absent from the
* {@code request}, or the {@code type}'s default-default otherwise
*/
public static <T> T getValue(IEditCommandRequest request, String parameterName, Class<T> type) {
T result;
try {
if (type == Boolean.class) {
Boolean booleanResult = (Boolean) request.getParameter(parameterName);
if (booleanResult == null) {
booleanResult = defaultBoolean(parameterName);
}
result = type.cast(booleanResult);
} else {
result = type.cast(Defaults.defaultValue(type));
}
} catch (IllegalArgumentException e) {
// The parameter doesn't specify a default
result = type.cast(Defaults.defaultValue(type));
}
return result;
}
/**
* Queries the default value of a boolean-valued request parameter.
*
* @param parameterName
* the boolean-value parameter for which to obtain the default value
*
* @return the default value
*
* @throws IllegalArgumentException
* if the parameter is not boolean-valued or if it does not have a default value
*/
public static boolean defaultBoolean(String parameterName) {
switch (parameterName) {
case AFFECTS_SOURCE:
return true;
case AFFECTS_TARGET:
return false;
default:
throw new IllegalArgumentException("Not a boolean parameter or not defaulted: " + parameterName); //$NON-NLS-1$
}
}
}
}
|
