Skip to main content
aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorDani Megert2004-06-23 13:37:51 +0000
committerDani Megert2004-06-23 13:37:51 +0000
commitbb6ef114c0ce93c4a75ffbf4f8e0b7dfa4cdf126 (patch)
treee12da0de160585812c237434da3330446490fc14 /org.eclipse.ui.editors/src/org/eclipse/ui/editors/text/TextEditorMessages.java
parentcab0475aa15fc739d1b600205c0efca2717633d0 (diff)
downloadeclipse.platform.text-bb6ef114c0ce93c4a75ffbf4f8e0b7dfa4cdf126.tar.gz
eclipse.platform.text-bb6ef114c0ce93c4a75ffbf4f8e0b7dfa4cdf126.tar.xz
eclipse.platform.text-bb6ef114c0ce93c4a75ffbf4f8e0b7dfa4cdf126.zip
Javadoc updates
Diffstat (limited to 'org.eclipse.ui.editors/src/org/eclipse/ui/editors/text/TextEditorMessages.java')
-rw-r--r--org.eclipse.ui.editors/src/org/eclipse/ui/editors/text/TextEditorMessages.java17
1 files changed, 16 insertions, 1 deletions
diff --git a/org.eclipse.ui.editors/src/org/eclipse/ui/editors/text/TextEditorMessages.java b/org.eclipse.ui.editors/src/org/eclipse/ui/editors/text/TextEditorMessages.java
index 40eff3830d7..cd4644891d8 100644
--- a/org.eclipse.ui.editors/src/org/eclipse/ui/editors/text/TextEditorMessages.java
+++ b/org.eclipse.ui.editors/src/org/eclipse/ui/editors/text/TextEditorMessages.java
@@ -1,5 +1,5 @@
/*******************************************************************************
- * Copyright (c) 2000, 2003 IBM Corporation and others.
+ * Copyright (c) 2000, 2004 IBM Corporation and others.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Common Public License v1.0
* which accompanies this distribution, and is available at
@@ -14,6 +14,9 @@ import java.text.MessageFormat;
import java.util.MissingResourceException;
import java.util.ResourceBundle;
+/**
+ * Helper class to get NLSed messages.
+ */
class TextEditorMessages {
private static final String RESOURCE_BUNDLE= "org.eclipse.ui.editors.text.TextEditorMessages";//$NON-NLS-1$
@@ -23,6 +26,12 @@ class TextEditorMessages {
private TextEditorMessages() {
}
+ /**
+ * Gets a string from the resource bundle.
+ *
+ * @param key the string used to get the bundle value, must not be <code>null</code>
+ * @return the string from the resource bundle
+ */
public static String getString(String key) {
try {
return fgResourceBundle.getString(key);
@@ -37,6 +46,7 @@ class TextEditorMessages {
* @param key the string used to get the bundle value, must not be null
* @param arg the argument used to format the string
* @return the formatted string
+ * @since 3.0
*/
public static String getFormattedString(String key, Object arg) {
String format= null;
@@ -50,6 +60,11 @@ class TextEditorMessages {
return MessageFormat.format(format, new Object[] { arg });
}
+ /**
+ * Returns a resource bundle.
+ *
+ * @return the resource bundle
+ */
public static ResourceBundle getResourceBundle() {
return fgResourceBundle;
}

Back to the top