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
|
/*****************************************************************************
* Copyright (c) 2013 CEA LIST.
*
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License 2.0
* which accompanies this distribution, and is available at
* https://www.eclipse.org/legal/epl-2.0/
*
* SPDX-License-Identifier: EPL-2.0
*
* Contributors:
* CEA LIST - Initial API and implementation
*****************************************************************************/
package org.eclipse.papyrus.views.properties.runtime;
import static org.eclipse.papyrus.views.properties.runtime.preferences.Preferences.CURRENT_VERSION;
import java.lang.reflect.Method;
import java.util.Locale;
import org.eclipse.osgi.util.NLS;
import org.eclipse.papyrus.infra.properties.contexts.Context;
import org.eclipse.papyrus.views.properties.Activator;
import org.eclipse.papyrus.views.properties.runtime.preferences.ContextDescriptor;
import org.eclipse.papyrus.views.properties.runtime.preferences.Preferences;
/**
* A migration handler for the preferences model in workspace upgrade.
*/
class PreferencesMigrator {
private final ConfigurationManager manager;
PreferencesMigrator(ConfigurationManager manager) {
super();
this.manager = manager;
}
/**
* Processes the {@code preferences} to apply any required data migration.
*
* @param preferences
* the preferences to migrate, if necessary
*
* @return whether any changes were made to the preferences that need to be saved
*/
public boolean process(Preferences preferences) {
int version = preferences.getVersion();
if ((version < 1) || (version > CURRENT_VERSION)) {
Activator.log.warn(NLS.bind("Unknown version number {0} in Properties View preferences. Properties view preferences may function erratically or not at all.", version));
return false;
}
boolean result = false;
// step-by-step migration in case user missed any intermediate versions
for (int i = version; i < CURRENT_VERSION; i++) {
migrate(preferences, i, i + 1);
preferences.setVersion(i + 1);
result = true;
}
return result;
}
private void migrate(Preferences preferences, int fromVersion, int toVersion) {
try {
// would use Locale.ROOT, except it is new in JDK1.6
Method method = getClass().getDeclaredMethod(String.format(Locale.ENGLISH, "migrateFrom%dTo%d", fromVersion, toVersion), Preferences.class);
method.invoke(this, preferences);
} catch (Exception e) {
Activator.log.error("Failed to invoke migration step.", e);
}
}
void migrateFrom1To2(Preferences preferences) {
// new in version 2 is the concept of a "missing" context that is just temporarily inaccessible
// and wasn't explicitly deleted. So, we scan for profiles that are missing and mark them
// deleted because that's the only way they should have gone missing in version 1
// iterate a copy in case the migration step or the ConfigurationManager changes the list
for (ContextDescriptor next : new java.util.ArrayList<ContextDescriptor>(preferences.getContexts())) {
// sanity check: if it has a prototype, then somebody created it after this capability
// was introduced but before we added the version number and migration semantics
if (next.getPrototype() == null) {
// if the context doesn't exist and it was unapplied, assume that it was deleted because
// deletion unapplied the context
if (!next.isApplied() && manager.getContext(next.getName()) == null) {
next.setDeleted(true);
}
}
}
}
void migrateFrom2To3(Preferences preferences) {
// new version3 introduce appliedByDefault, by default only context defined by plugin are applied
for (ContextDescriptor next : new java.util.ArrayList<ContextDescriptor>(preferences.getContexts())) {
Context context = manager.getContext(next.getName());
if (context != null) {
if (ConfigurationManager.getInstance().isPlugin(context)) {
next.setAppliedByDefault(true);
} else {
next.setAppliedByDefault(false);
}
}
}
}
}
|
