Skip to content

Commit ce2d2cd

Browse files
SougandhSlaeubi
SougandhS
authored and
laeubi
committed
Externalize hardcoded strings for consistency and reuse
Externalized strings in core.internal.variables package to eliminate redundancy and enhance code maintainability.
1 parent 8aa4a91 commit ce2d2cd

File tree

5 files changed

+66
-22
lines changed

5 files changed

+66
-22
lines changed

‎debug/org.eclipse.core.variables/src/org/eclipse/core/internal/variables/ContributedValueVariable.java‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*******************************************************************************
2-
* Copyright (c) 2000, 2013 IBM Corporation and others.
2+
* Copyright (c) 2000, 2025 IBM Corporation and others.
33
*
44
* This program and the accompanying materials
55
* are made available under the terms of the Eclipse Public License 2.0
@@ -88,10 +88,10 @@ private void initialize() {
8888
if (object instanceof IValueVariableInitializer initializer) {
8989
initializer.initialize(this);
9090
} else {
91-
VariablesPlugin.logMessage(NLS.bind("Unable to initialize variable {0} - initializer must be an instance of IValueVariableInitializer.", getName()), null); //$NON-NLS-1$
91+
VariablesPlugin.logMessage(NLS.bind(VariablesMessages.VarInitFailDueNonIValueVariable, getName()), null);
9292
}
9393
} catch (CoreException e) {
94-
VariablesPlugin.logMessage(NLS.bind("Unable to initialize variable {0}", getName()), e); //$NON-NLS-1$
94+
VariablesPlugin.logMessage(NLS.bind(VariablesMessages.VarInitFail, getName()), e);
9595
}
9696
}
9797
} else {

‎debug/org.eclipse.core.variables/src/org/eclipse/core/internal/variables/DynamicVariable.java‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*******************************************************************************
2-
* Copyright (c) 2000, 2013 IBM Corporation and others.
2+
* Copyright (c) 2000, 2025 IBM Corporation and others.
33
*
44
* This program and the accompanying materials
55
* are made available under the terms of the Eclipse Public License 2.0
@@ -43,19 +43,19 @@ public String getValue(String argument) throws CoreException {
4343
if (fResolver == null) {
4444
String name = getConfigurationElement().getAttribute("resolver"); //$NON-NLS-1$
4545
if (name == null) {
46-
throw new CoreException(new Status(IStatus.ERROR, VariablesPlugin.getUniqueIdentifier(), VariablesPlugin.INTERNAL_ERROR, NLS.bind("Contributed context variable {0} must specify a resolver.", getName()), null)); //$NON-NLS-1$
46+
throw new CoreException(new Status(IStatus.ERROR, VariablesPlugin.getUniqueIdentifier(), VariablesPlugin.INTERNAL_ERROR, NLS.bind(VariablesMessages.VarMissingResolver, getName()), null));
4747
}
4848
Object object = getConfigurationElement().createExecutableExtension("resolver"); //$NON-NLS-1$
4949
if (object instanceof IDynamicVariableResolver) {
5050
fResolver = (IDynamicVariableResolver)object;
5151
} else {
52-
throw new CoreException(new Status(IStatus.ERROR, VariablesPlugin.getUniqueIdentifier(), VariablesPlugin.INTERNAL_ERROR, NLS.bind("Contributed context variable resolver for {0} must be an instance of IContextVariableResolver.", getName()), null)); //$NON-NLS-1$
52+
throw new CoreException(new Status(IStatus.ERROR, VariablesPlugin.getUniqueIdentifier(), VariablesPlugin.INTERNAL_ERROR, NLS.bind(VariablesMessages.VarResolverNotIContextVariableResolver, getName()), null));
5353
}
5454
}
5555
try {
5656
return fResolver.resolveValue(this, argument);
5757
} catch (RuntimeException e) {
58-
throw new CoreException(new Status(IStatus.ERROR, VariablesPlugin.getUniqueIdentifier(), VariablesPlugin.INTERNAL_ERROR, NLS.bind("Error while evaluating variable {0}.", getName()), e)); //$NON-NLS-1$
58+
throw new CoreException(new Status(IStatus.ERROR, VariablesPlugin.getUniqueIdentifier(), VariablesPlugin.INTERNAL_ERROR, NLS.bind(VariablesMessages.VarEvalError, getName()), e));
5959
}
6060
}
6161

‎debug/org.eclipse.core.variables/src/org/eclipse/core/internal/variables/StringVariableManager.java‎

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*******************************************************************************
2-
* Copyright (c) 2000, 2018 IBM Corporation and others.
2+
* Copyright (c) 2000, 2025 IBM Corporation and others.
33
*
44
* This program and the accompanying materials
55
* are made available under the terms of the Eclipse Public License 2.0
@@ -126,7 +126,7 @@ class StringVariableNotifier implements ISafeRunnable {
126126
*/
127127
@Override
128128
public void handleException(Throwable exception) {
129-
IStatus status = new Status(IStatus.ERROR, VariablesPlugin.getUniqueIdentifier(), VariablesPlugin.INTERNAL_ERROR, "An exception occurred during string variable change notification", exception); //$NON-NLS-1$
129+
IStatus status = new Status(IStatus.ERROR, VariablesPlugin.getUniqueIdentifier(), VariablesPlugin.INTERNAL_ERROR, VariablesMessages.StringVarExceptionOnChange, exception);
130130
VariablesPlugin.log(status);
131131
}
132132

@@ -223,15 +223,15 @@ private void loadDynamicVariables() {
223223
for (IConfigurationElement element : elements) {
224224
String name= element.getAttribute(ATTR_NAME);
225225
if (name == null) {
226-
VariablesPlugin.logMessage(NLS.bind("Variable extension missing required 'name' attribute: {0}", element.getDeclaringExtension().getLabel()), null); //$NON-NLS-1$
226+
VariablesPlugin.logMessage(NLS.bind(VariablesMessages.StringVarMissingNameExt, element.getDeclaringExtension().getLabel()), null);
227227
continue;
228228
}
229229
String description= element.getAttribute(ATTR_DESCRIPTION);
230230
DynamicVariable variable= new DynamicVariable(name, description, element);
231231
Object old = fDynamicVariables.put(variable.getName(), variable);
232232
if (old != null) {
233233
DynamicVariable oldVariable = (DynamicVariable)old;
234-
VariablesPlugin.logMessage(NLS.bind("Dynamic variable extension from bundle ''{0}'' overrides existing extension variable ''{1}'' from bundle ''{2}''", //$NON-NLS-1$
234+
VariablesPlugin.logMessage(NLS.bind(VariablesMessages.StringVarExtOverridesOnBundles,
235235
element.getDeclaringExtension().getContributor().getName(), oldVariable.getName(), oldVariable.getConfigurationElement().getDeclaringExtension().getContributor().getName()), null);
236236
}
237237
}
@@ -246,7 +246,7 @@ private void loadContributedValueVariables() {
246246
for (IConfigurationElement element : elements) {
247247
String name= element.getAttribute(ATTR_NAME);
248248
if (name == null) {
249-
VariablesPlugin.logMessage(NLS.bind("Variable extension missing required 'name' attribute: {0}", element.getDeclaringExtension().getLabel()), null); //$NON-NLS-1$
249+
VariablesPlugin.logMessage(NLS.bind(VariablesMessages.StringVarMissingNameExt, element.getDeclaringExtension().getLabel()), null);
250250
continue;
251251
}
252252
String description= element.getAttribute(ATTR_DESCRIPTION);
@@ -256,7 +256,7 @@ private void loadContributedValueVariables() {
256256
Object old = fValueVariables.put(name, variable);
257257
if (old != null) {
258258
StringVariable oldVariable = (StringVariable)old;
259-
VariablesPlugin.logMessage(NLS.bind("Contributed variable extension from bundle ''{0}'' overrides existing extension variable ''{1}'' from bundle ''{2}''", //$NON-NLS-1$
259+
VariablesPlugin.logMessage(NLS.bind(VariablesMessages.StringVarContExtOverridesOnBundles,
260260
element.getDeclaringExtension().getContributor().getName(), oldVariable.getName(), oldVariable.getConfigurationElement().getDeclaringExtension().getContributor().getName()), null);
261261
}
262262
}
@@ -282,11 +282,11 @@ private void loadPersistedValueVariables() {
282282
parser.setErrorHandler(new DefaultHandler());
283283
root = parser.parse(stream).getDocumentElement();
284284
} catch (Exception e) {
285-
VariablesPlugin.logMessage("An exception occurred while loading persisted value variables.", e); //$NON-NLS-1$
285+
VariablesPlugin.logMessage(VariablesMessages.StringVarExceptionOnLoad, e);
286286
return;
287287
}
288288
if (!root.getNodeName().equals(VALUE_VARIABLES_TAG)) {
289-
VariablesPlugin.logMessage("Invalid format encountered while loading persisted value variables.", null); //$NON-NLS-1$
289+
VariablesPlugin.logMessage(VariablesMessages.StringVarInvalidFormat, null);
290290
return;
291291
}
292292
NodeList list= root.getChildNodes();
@@ -295,7 +295,7 @@ private void loadPersistedValueVariables() {
295295
if (node.getNodeType() == Node.ELEMENT_NODE) {
296296
Element element= (Element) node;
297297
if (!element.getNodeName().equals(VALUE_VARIABLE_TAG)) {
298-
VariablesPlugin.logMessage(NLS.bind("Invalid XML element encountered while loading value variables: {0}", node.getNodeName()), null); //$NON-NLS-1$
298+
VariablesPlugin.logMessage(NLS.bind(VariablesMessages.StringVarInvalidXML, node.getNodeName()), null);
299299
continue;
300300
}
301301
String name= element.getAttribute(NAME_TAG);
@@ -312,7 +312,7 @@ private void loadPersistedValueVariables() {
312312
existing.setValue(value);
313313
}
314314
} else {
315-
VariablesPlugin.logMessage("Invalid variable entry encountered while loading value variables. Variable name is null.", null); //$NON-NLS-1$
315+
VariablesPlugin.logMessage(VariablesMessages.StringVarNameNull, null);
316316
}
317317
}
318318
}
@@ -489,13 +489,13 @@ private synchronized void storeValueVariables() {
489489
try {
490490
variableString= getValueVariablesAsXML();
491491
} catch (IOException e) {
492-
VariablesPlugin.log(new Status(IStatus.ERROR, VariablesPlugin.getUniqueIdentifier(), IStatus.ERROR, "An exception occurred while storing launch configuration variables.", e)); //$NON-NLS-1$
492+
VariablesPlugin.log(new Status(IStatus.ERROR, VariablesPlugin.getUniqueIdentifier(), IStatus.ERROR, VariablesMessages.StringVarLaunchExcep, e));
493493
return;
494494
} catch (ParserConfigurationException e) {
495-
VariablesPlugin.log(new Status(IStatus.ERROR, VariablesPlugin.getUniqueIdentifier(), IStatus.ERROR, "An exception occurred while storing launch configuration variables.", e)); //$NON-NLS-1$
495+
VariablesPlugin.log(new Status(IStatus.ERROR, VariablesPlugin.getUniqueIdentifier(), IStatus.ERROR, VariablesMessages.StringVarLaunchExcep, e));
496496
return;
497497
} catch (TransformerException e) {
498-
VariablesPlugin.log(new Status(IStatus.ERROR, VariablesPlugin.getUniqueIdentifier(), IStatus.ERROR, "An exception occurred while storing launch configuration variables.", e)); //$NON-NLS-1$
498+
VariablesPlugin.log(new Status(IStatus.ERROR, VariablesPlugin.getUniqueIdentifier(), IStatus.ERROR, VariablesMessages.StringVarLaunchExcep, e));
499499
return;
500500
}
501501
}

‎debug/org.eclipse.core.variables/src/org/eclipse/core/internal/variables/VariablesMessages.java‎

Lines changed: 29 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*******************************************************************************
2-
* Copyright (c) 2000, 2009 IBM Corporation and others.
2+
* Copyright (c) 2000, 2025 IBM Corporation and others.
33
*
44
* This program and the accompanying materials
55
* are made available under the terms of the Eclipse Public License 2.0
@@ -26,6 +26,34 @@ public class VariablesMessages extends NLS {
2626

2727
public static String DynamicVariable_0;
2828

29+
public static String VarMissingResolver;
30+
31+
public static String VarResolverNotIContextVariableResolver;
32+
33+
public static String VarEvalError;
34+
35+
public static String VarInitFailDueNonIValueVariable;
36+
37+
public static String VarInitFail;
38+
39+
public static String StringVarExceptionOnChange;
40+
41+
public static String StringVarMissingNameExt;
42+
43+
public static String StringVarExtOverridesOnBundles;
44+
45+
public static String StringVarContExtOverridesOnBundles;
46+
47+
public static String StringVarExceptionOnLoad;
48+
49+
public static String StringVarInvalidFormat;
50+
51+
public static String StringVarInvalidXML;
52+
53+
public static String StringVarNameNull;
54+
55+
public static String StringVarLaunchExcep;
56+
2957
static {
3058
// load message values from bundle file
3159
NLS.initializeMessages(BUNDLE_NAME, VariablesMessages.class);

‎debug/org.eclipse.core.variables/src/org/eclipse/core/internal/variables/VariablesMessages.properties‎

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
###############################################################################
2-
# Copyright (c) 2000, 2005 IBM Corporation and others.
2+
# Copyright (c) 2000, 2025 IBM Corporation and others.
33
#
44
# This program and the accompanying materials
55
# are made available under the terms of the Eclipse Public License 2.0
@@ -19,3 +19,19 @@ StringVariableManager_26=Variables with the specified names are already register
1919
StringVariableManager_27=Variable named {0} already registered
2020

2121
DynamicVariable_0=Unsupported argument {0} specified for variable {1}
22+
VarMissingResolver=Contributed context variable {0} must specify a resolver.
23+
VarResolverNotIContextVariableResolver=Contributed context variable resolver for {0} must be an instance of IContextVariableResolver.
24+
VarEvalError=Error while evaluating variable {0}.
25+
26+
VarInitFailDueNonIValueVariable=Unable to initialize variable {0} - initializer must be an instance of IValueVariableInitializer.
27+
VarInitFail=Unable to initialize variable {0}
28+
29+
StringVarExceptionOnChange=An exception occurred during string variable change notification
30+
StringVarMissingNameExt=Variable extension missing required 'name' attribute: {0}
31+
StringVarExtOverridesOnBundles=Dynamic variable extension from bundle ''{0}'' overrides existing extension variable ''{1}'' from bundle ''{2}''
32+
StringVarContExtOverridesOnBundles=Contributed variable extension from bundle ''{0}'' overrides existing extension variable ''{1}'' from bundle ''{2}''
33+
StringVarExceptionOnLoad=An exception occurred while loading persisted value variables.
34+
StringVarInvalidFormat=Invalid format encountered while loading persisted value variables.
35+
StringVarInvalidXML=Invalid XML element encountered while loading value variables: {0}
36+
StringVarNameNull=Invalid variable entry encountered while loading value variables. Variable name is null.
37+
StringVarLaunchExcep=An exception occurred while storing launch configuration variables.

0 commit comments

Comments
 (0)