[icedtea-web] RFC: unify localization code
Deepak Bhole
dbhole at redhat.com
Mon Oct 25 11:24:46 PDT 2010
* Omair Majid <omajid at redhat.com> [2010-10-25 14:22]:
> On 10/25/2010 02:20 PM, Omair Majid wrote:
> >On 10/25/2010 01:22 PM, Deepak Bhole wrote:
> >>* Omair Majid<omajid at redhat.com> [2010-10-25 12:54]:
> >>>Hi,
> >>>
> >>>Netx contains a number of duplicate methods named "R" defined in
> >>>various files that act as a wrapper for JNLPRuntime.getMessage().
> >>>The attached patch creates a new class Translate and moves all the
> >>>"R" methods to it. This set of overloaded "R" methods is then
> >>>statically imported anywhere that needs localized strings.
> >>>
> >>
> >>While it is being refactored, why not use varargs for R()?
> >>
> >
> >Fixed.
>
> Grr.. Accceidentally sent without finishing email :(
>
> Here is the attachment.
>
Looks good. Okay for commit to HEAD.
Deepak
> Thanks,
> Omair
>
> diff -r e9910d92b046 netx/net/sourceforge/jnlp/ExtensionDesc.java
> --- a/netx/net/sourceforge/jnlp/ExtensionDesc.java Mon Oct 25 12:14:33 2010 -0400
> +++ b/netx/net/sourceforge/jnlp/ExtensionDesc.java Mon Oct 25 14:15:45 2010 -0400
> @@ -17,13 +17,14 @@
>
> package net.sourceforge.jnlp;
>
> +import static net.sourceforge.jnlp.runtime.Translator.R;
> +
> import java.io.*;
> import java.net.*;
> import java.util.*;
>
> import net.sourceforge.jnlp.runtime.JNLPRuntime;
>
> -
> /**
> * The extension element.
> *
> @@ -128,7 +129,7 @@
>
> // check for it being an extension descriptor
> if (!file.isComponent() && !file.isInstaller())
> - throw new ParseException(JNLPRuntime.getMessage("JInvalidExtensionDescriptor", new Object[] {name, location} ));
> + throw new ParseException(R("JInvalidExtensionDescriptor", name, location));
> }
>
> }
> diff -r e9910d92b046 netx/net/sourceforge/jnlp/JNLPFile.java
> --- a/netx/net/sourceforge/jnlp/JNLPFile.java Mon Oct 25 12:14:33 2010 -0400
> +++ b/netx/net/sourceforge/jnlp/JNLPFile.java Mon Oct 25 14:15:45 2010 -0400
> @@ -17,6 +17,8 @@
>
> package net.sourceforge.jnlp;
>
> +import static net.sourceforge.jnlp.runtime.Translator.R;
> +
> import java.io.IOException;
> import java.io.InputStream;
> import java.io.Reader;
> @@ -32,6 +34,7 @@
> import net.sourceforge.jnlp.cache.UpdatePolicy;
> import net.sourceforge.jnlp.runtime.JNLPRuntime;
>
> +
> /**
> * Provides methods to access the information in a Java Network
> * Launching Protocol (JNLP) file. The Java Network Launching
> @@ -60,8 +63,6 @@
> // todo: currently does not filter resources by jvm version.
> //
>
> - private static String R(String key) { return JNLPRuntime.getMessage(key); }
> -
> /** the location this JNLP file was created from */
> protected URL sourceLocation = null;
>
> diff -r e9910d92b046 netx/net/sourceforge/jnlp/JREDesc.java
> --- a/netx/net/sourceforge/jnlp/JREDesc.java Mon Oct 25 12:14:33 2010 -0400
> +++ b/netx/net/sourceforge/jnlp/JREDesc.java Mon Oct 25 14:15:45 2010 -0400
> @@ -17,12 +17,12 @@
>
> package net.sourceforge.jnlp;
>
> +import static net.sourceforge.jnlp.runtime.Translator.R;
> +
> import java.io.*;
> import java.net.*;
> import java.util.*;
>
> -import net.sourceforge.jnlp.runtime.JNLPRuntime;
> -
> /**
> * The J2SE/Java element.
> *
> @@ -143,7 +143,7 @@
> if ((lastChar < '0' || lastChar > '9')) {
> lastCharacterIsDigit = false;
> if (lastChar != 'k' && lastChar!= 'm' ) {
> - throw new ParseException(JNLPRuntime.getMessage("PBadHeapSize",new Object[] {heapSize}));
> + throw new ParseException(R("PBadHeapSize", heapSize));
> }
> }
>
> @@ -157,7 +157,7 @@
> // check that the number is a number!
> Integer.valueOf(size);
> } catch (NumberFormatException numberFormat) {
> - throw new ParseException(JNLPRuntime.getMessage("PBadHeapSize", new Object[] {heapSize}), numberFormat);
> + throw new ParseException(R("PBadHeapSize", heapSize), numberFormat);
> }
>
> }
> diff -r e9910d92b046 netx/net/sourceforge/jnlp/Launcher.java
> --- a/netx/net/sourceforge/jnlp/Launcher.java Mon Oct 25 12:14:33 2010 -0400
> +++ b/netx/net/sourceforge/jnlp/Launcher.java Mon Oct 25 14:15:45 2010 -0400
> @@ -17,6 +17,8 @@
>
> package net.sourceforge.jnlp;
>
> +import static net.sourceforge.jnlp.runtime.Translator.R;
> +
> import java.applet.Applet;
> import java.awt.Container;
> import java.io.File;
> @@ -51,6 +53,7 @@
>
> import sun.awt.SunToolkit;
>
> +
> /**
> * Launches JNLPFiles either in the foreground or background.<p>
> *
> @@ -67,9 +70,6 @@
>
> // defines class Launcher.BgRunner, Launcher.TgThread
>
> - /** shortcut for resources */
> - private static String R(String key) { return JNLPRuntime.getMessage(key); }
> -
> /** shared thread group */
> /*package*/ static final ThreadGroup mainGroup = new ThreadGroup(R("LAllThreadGroup"));
>
> diff -r e9910d92b046 netx/net/sourceforge/jnlp/Parser.java
> --- a/netx/net/sourceforge/jnlp/Parser.java Mon Oct 25 12:14:33 2010 -0400
> +++ b/netx/net/sourceforge/jnlp/Parser.java Mon Oct 25 14:15:45 2010 -0400
> @@ -18,6 +18,8 @@
>
> package net.sourceforge.jnlp;
>
> +import static net.sourceforge.jnlp.runtime.Translator.R;
> +
> import java.io.*;
> import java.net.*;
> import java.util.*;
> @@ -27,10 +29,8 @@
> //import gd.xml.tiny.*;
> import net.sourceforge.jnlp.UpdateDesc.Check;
> import net.sourceforge.jnlp.UpdateDesc.Policy;
> -import net.sourceforge.jnlp.runtime.JNLPRuntime;
> import net.sourceforge.nanoxml.*;
>
> -
> /**
> * Contains methods to parse an XML document into a JNLPFile.
> * Implements JNLP specification version 1.0.
> @@ -40,12 +40,6 @@
> */
> class Parser {
>
> - private static String R(String key) { return JNLPRuntime.getMessage(key); }
> - private static String R(String key, Object p1) { return R(key, p1, null); }
> - private static String R(String key, Object p1, Object p2) { return R(key, p1, p2, null); }
> - private static String R(String key, Object p1, Object p2, Object p3) { return JNLPRuntime.getMessage(key, new Object[] { p1, p2, p3 }); }
> -
> -
> // defines netx.jnlp.Node class if using Tiny XML or Nano XML
>
> // Currently uses the Nano XML parse. Search for "SAX" or
> diff -r e9910d92b046 netx/net/sourceforge/jnlp/cache/CacheEntry.java
> --- a/netx/net/sourceforge/jnlp/cache/CacheEntry.java Mon Oct 25 12:14:33 2010 -0400
> +++ b/netx/net/sourceforge/jnlp/cache/CacheEntry.java Mon Oct 25 14:15:45 2010 -0400
> @@ -17,6 +17,8 @@
>
> package net.sourceforge.jnlp.cache;
>
> +import static net.sourceforge.jnlp.runtime.Translator.R;
> +
> import java.io.*;
> import java.net.*;
> import java.util.*;
> @@ -60,7 +62,7 @@
> File infoFile = CacheUtil.getCacheFile(location, version);
> infoFile = new File(infoFile.getPath()+".info"); // replace with something that can't be clobbered
>
> - properties = new PropertiesFile(infoFile, JNLPRuntime.getMessage("CAutoGen"));
> + properties = new PropertiesFile(infoFile, R("CAutoGen"));
> }
>
> /**
> diff -r e9910d92b046 netx/net/sourceforge/jnlp/cache/CacheUtil.java
> --- a/netx/net/sourceforge/jnlp/cache/CacheUtil.java Mon Oct 25 12:14:33 2010 -0400
> +++ b/netx/net/sourceforge/jnlp/cache/CacheUtil.java Mon Oct 25 14:15:45 2010 -0400
> @@ -17,6 +17,8 @@
>
> package net.sourceforge.jnlp.cache;
>
> +import static net.sourceforge.jnlp.runtime.Translator.R;
> +
> import java.io.*;
> import java.net.*;
> import java.nio.channels.FileChannel;
> @@ -38,14 +40,6 @@
> */
> public class CacheUtil {
>
> - private static String R(String key) {
> - return JNLPRuntime.getMessage(key);
> - }
> -
> - private static String R(String key, Object param) {
> - return JNLPRuntime.getMessage(key, new Object[] {param});
> - }
> -
> /**
> * Compares a URL using string compare of its protocol, host,
> * port, path, query, and anchor. This method avoids the host
> diff -r e9910d92b046 netx/net/sourceforge/jnlp/cache/DefaultDownloadIndicator.java
> --- a/netx/net/sourceforge/jnlp/cache/DefaultDownloadIndicator.java Mon Oct 25 12:14:33 2010 -0400
> +++ b/netx/net/sourceforge/jnlp/cache/DefaultDownloadIndicator.java Mon Oct 25 14:15:45 2010 -0400
> @@ -17,6 +17,8 @@
>
> package net.sourceforge.jnlp.cache;
>
> +import static net.sourceforge.jnlp.runtime.Translator.R;
> +
> import java.awt.*;
> import java.awt.event.*;
> import java.net.*;
> @@ -49,8 +51,8 @@
> // todo: this should be synchronized at some point but conflicts
> // aren't very likely.
>
> - private static String downloading = JNLPRuntime.getMessage("CDownloading");
> - private static String complete = JNLPRuntime.getMessage("CComplete");
> + private static String downloading = R("CDownloading");
> + private static String complete = R("CComplete");
>
> /** time to wait after completing but before window closes */
> private static final int CLOSE_DELAY = 750;
> diff -r e9910d92b046 netx/net/sourceforge/jnlp/runtime/Boot.java
> --- a/netx/net/sourceforge/jnlp/runtime/Boot.java Mon Oct 25 12:14:33 2010 -0400
> +++ b/netx/net/sourceforge/jnlp/runtime/Boot.java Mon Oct 25 14:15:45 2010 -0400
> @@ -17,6 +17,8 @@
>
> package net.sourceforge.jnlp.runtime;
>
> +import static net.sourceforge.jnlp.runtime.Translator.R;
> +
> import java.io.File;
> import java.io.IOException;
> import java.net.MalformedURLException;
> @@ -63,9 +65,6 @@
> // todo: decide whether a spawned netx (external launch)
> // should inherit the same options as this instance (store argv?)
>
> - private static String R(String key) { return JNLPRuntime.getMessage(key); }
> - private static String R(String key, Object param) { return JNLPRuntime.getMessage(key, new Object[] {param}); }
> -
> private static final String version = "0.5";
>
> /** the text to display before launching the about link */
> @@ -225,8 +224,7 @@
> if (JNLPRuntime.isDebug())
> ex.printStackTrace();
>
> - fatalError(JNLPRuntime.getMessage("RUnexpected",
> - new Object[] {ex.toString(), ex.getStackTrace()[0]} ));
> + fatalError(R("RUnexpected", ex.toString(), ex.getStackTrace()[0]));
> }
>
> return null;
> diff -r e9910d92b046 netx/net/sourceforge/jnlp/runtime/JNLPClassLoader.java
> --- a/netx/net/sourceforge/jnlp/runtime/JNLPClassLoader.java Mon Oct 25 12:14:33 2010 -0400
> +++ b/netx/net/sourceforge/jnlp/runtime/JNLPClassLoader.java Mon Oct 25 14:15:45 2010 -0400
> @@ -17,6 +17,8 @@
>
> package net.sourceforge.jnlp.runtime;
>
> +import static net.sourceforge.jnlp.runtime.Translator.R;
> +
> import java.io.File;
> import java.io.FileOutputStream;
> import java.io.IOException;
> @@ -78,9 +80,6 @@
> // extension classes too so that main file classes can load
> // resources in an extension.
>
> - /** shortcut for resources */
> - private static String R(String key) { return JNLPRuntime.getMessage(key); }
> -
> /** map from JNLPFile url to shared classloader */
> private static Map<String,JNLPClassLoader> urlToLoader =
> new HashMap<String,JNLPClassLoader>(); // never garbage collected!
> diff -r e9910d92b046 netx/net/sourceforge/jnlp/runtime/JNLPRuntime.java
> --- a/netx/net/sourceforge/jnlp/runtime/JNLPRuntime.java Mon Oct 25 12:14:33 2010 -0400
> +++ b/netx/net/sourceforge/jnlp/runtime/JNLPRuntime.java Mon Oct 25 14:15:45 2010 -0400
> @@ -522,7 +522,7 @@
> *
> * @param args the formatting arguments to the resource string
> */
> - public static String getMessage(String key, Object args[]) {
> + public static String getMessage(String key, Object... args) {
> return MessageFormat.format(getMessage(key), args);
> }
>
> diff -r e9910d92b046 netx/net/sourceforge/jnlp/runtime/JNLPSecurityManager.java
> --- a/netx/net/sourceforge/jnlp/runtime/JNLPSecurityManager.java Mon Oct 25 12:14:33 2010 -0400
> +++ b/netx/net/sourceforge/jnlp/runtime/JNLPSecurityManager.java Mon Oct 25 14:15:45 2010 -0400
> @@ -17,6 +17,8 @@
>
> package net.sourceforge.jnlp.runtime;
>
> +import static net.sourceforge.jnlp.runtime.Translator.R;
> +
> import java.awt.Frame;
> import java.awt.Window;
> import java.awt.event.WindowAdapter;
> @@ -88,14 +90,12 @@
> // another way for different apps to have different properties
> // in java.lang.Sytem with the same names.
>
> - private static String R(String key) { return JNLPRuntime.getMessage(key); }
> -
> /** only class that can exit the JVM, if set */
> private Object exitClass = null;
>
> /** this exception prevents exiting the JVM */
> private SecurityException closeAppEx = // making here prevents huge stack traces
> - new SecurityException(JNLPRuntime.getMessage("RShutdown"));
> + new SecurityException(R("RShutdown"));
>
> /** weak list of windows created */
> private WeakList<Window> weakWindows = new WeakList<Window>();
> diff -r e9910d92b046 netx/net/sourceforge/jnlp/runtime/Translator.java
> --- /dev/null Thu Jan 01 00:00:00 1970 +0000
> +++ b/netx/net/sourceforge/jnlp/runtime/Translator.java Mon Oct 25 14:15:45 2010 -0400
> @@ -0,0 +1,31 @@
> +// Copyright (C) 2010 Red Hat, Inc.
> +//
> +// This library is free software; you can redistribute it and/or
> +// modify it under the terms of the GNU Lesser General Public
> +// License as published by the Free Software Foundation; either
> +// version 2.1 of the License, or (at your option) any later version.
> +//
> +// This library is distributed in the hope that it will be useful,
> +// but WITHOUT ANY WARRANTY; without even the implied warranty of
> +// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
> +// Lesser General Public License for more details.
> +//
> +// You should have received a copy of the GNU Lesser General Public
> +// License along with this library; if not, write to the Free Software
> +// Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
> +
> +package net.sourceforge.jnlp.runtime;
> +
> +/**
> + * Utility class to provide simple methods to help localize messages
> + */
> +public class Translator {
> +
> + /**
> + * @return the localized string for the message
> + */
> + public static String R(String message, Object... params) {
> + return JNLPRuntime.getMessage(message, params);
> + }
> +
> +}
> diff -r e9910d92b046 netx/net/sourceforge/jnlp/security/AccessWarningPane.java
> --- a/netx/net/sourceforge/jnlp/security/AccessWarningPane.java Mon Oct 25 12:14:33 2010 -0400
> +++ b/netx/net/sourceforge/jnlp/security/AccessWarningPane.java Mon Oct 25 14:15:45 2010 -0400
> @@ -37,6 +37,8 @@
>
> package net.sourceforge.jnlp.security;
>
> +import static net.sourceforge.jnlp.runtime.Translator.R;
> +
> import java.awt.BorderLayout;
> import java.awt.Color;
> import java.awt.Dimension;
> diff -r e9910d92b046 netx/net/sourceforge/jnlp/security/CertWarningPane.java
> --- a/netx/net/sourceforge/jnlp/security/CertWarningPane.java Mon Oct 25 12:14:33 2010 -0400
> +++ b/netx/net/sourceforge/jnlp/security/CertWarningPane.java Mon Oct 25 14:15:45 2010 -0400
> @@ -37,6 +37,8 @@
>
> package net.sourceforge.jnlp.security;
>
> +import static net.sourceforge.jnlp.runtime.Translator.R;
> +
> import java.awt.BorderLayout;
> import java.awt.Color;
> import java.awt.Dimension;
> diff -r e9910d92b046 netx/net/sourceforge/jnlp/security/HttpsCertVerifier.java
> --- a/netx/net/sourceforge/jnlp/security/HttpsCertVerifier.java Mon Oct 25 12:14:33 2010 -0400
> +++ b/netx/net/sourceforge/jnlp/security/HttpsCertVerifier.java Mon Oct 25 14:15:45 2010 -0400
> @@ -37,6 +37,8 @@
>
> package net.sourceforge.jnlp.security;
>
> +import static net.sourceforge.jnlp.runtime.Translator.R;
> +
> import java.io.IOException;
> import java.security.cert.CertPath;
> import java.security.cert.Certificate;
> @@ -50,7 +52,6 @@
> import java.util.Collection;
> import java.util.List;
>
> -import net.sourceforge.jnlp.runtime.JNLPRuntime;
> import net.sourceforge.jnlp.tools.KeyTool;
> import sun.security.util.DerValue;
> import sun.security.util.HostnameChecker;
> @@ -198,14 +199,6 @@
> details.add(detail);
> }
>
> - private static String R(String key) {
> - return JNLPRuntime.getMessage(key);
> - }
> -
> - private static String R(String key, String arg1, String arg2) {
> - return JNLPRuntime.getMessage(key, new Object[] { arg1, arg2 });
> - }
> -
> public Certificate getPublisher() {
> if (chain.length > 0)
> return (Certificate)chain[0];
> diff -r e9910d92b046 netx/net/sourceforge/jnlp/security/MoreInfoPane.java
> --- a/netx/net/sourceforge/jnlp/security/MoreInfoPane.java Mon Oct 25 12:14:33 2010 -0400
> +++ b/netx/net/sourceforge/jnlp/security/MoreInfoPane.java Mon Oct 25 14:15:45 2010 -0400
> @@ -37,6 +37,8 @@
>
> package net.sourceforge.jnlp.security;
>
> +import static net.sourceforge.jnlp.runtime.Translator.R;
> +
> import java.awt.BorderLayout;
> import java.awt.Dimension;
> import java.awt.GridLayout;
> diff -r e9910d92b046 netx/net/sourceforge/jnlp/security/SecurityDialogPanel.java
> --- a/netx/net/sourceforge/jnlp/security/SecurityDialogPanel.java Mon Oct 25 12:14:33 2010 -0400
> +++ b/netx/net/sourceforge/jnlp/security/SecurityDialogPanel.java Mon Oct 25 14:15:45 2010 -0400
> @@ -44,9 +44,6 @@
> import javax.swing.JComponent;
> import javax.swing.JPanel;
>
> -
> -import net.sourceforge.jnlp.runtime.JNLPRuntime;
> -
> /**
> * Provides a JPanel for use in JNLP warning dialogs.
> */
> @@ -69,18 +66,6 @@
> this.setLayout(new BorderLayout());
> }
>
> - /*
> - * String translation functions
> - */
> -
> - protected static String R(String key) {
> - return JNLPRuntime.getMessage(key);
> - }
> -
> - protected static String R(String key, Object param) {
> - return JNLPRuntime.getMessage(key, new Object[] {param});
> - }
> -
> /**
> * Needed to get word wrap working in JLabels.
> */
> diff -r e9910d92b046 netx/net/sourceforge/jnlp/services/ServiceUtil.java
> --- a/netx/net/sourceforge/jnlp/services/ServiceUtil.java Mon Oct 25 12:14:33 2010 -0400
> +++ b/netx/net/sourceforge/jnlp/services/ServiceUtil.java Mon Oct 25 14:15:45 2010 -0400
> @@ -53,10 +53,6 @@
> */
> public class ServiceUtil {
>
> - private static String R(String key) {
> - return JNLPRuntime.getMessage(key);
> - }
> -
> /**
> * Returns the BasicService reference, or null if the service is
> * unavailable.
> diff -r e9910d92b046 netx/net/sourceforge/jnlp/services/SingleInstanceLock.java
> --- a/netx/net/sourceforge/jnlp/services/SingleInstanceLock.java Mon Oct 25 12:14:33 2010 -0400
> +++ b/netx/net/sourceforge/jnlp/services/SingleInstanceLock.java Mon Oct 25 14:15:45 2010 -0400
> @@ -16,6 +16,8 @@
>
> package net.sourceforge.jnlp.services;
>
> +import static net.sourceforge.jnlp.runtime.Translator.R;
> +
> import java.io.BufferedReader;
> import java.io.BufferedWriter;
> import java.io.File;
> @@ -183,12 +185,4 @@
> return (display == null) ? "" : display;
> }
>
> - private static String R(String key) {
> - return JNLPRuntime.getMessage(key);
> - }
> -
> - private static String R(String key, Object param) {
> - return JNLPRuntime.getMessage(key, new Object[] { param });
> - }
> -
> }
> diff -r e9910d92b046 netx/net/sourceforge/jnlp/tools/JarSigner.java
> --- a/netx/net/sourceforge/jnlp/tools/JarSigner.java Mon Oct 25 12:14:33 2010 -0400
> +++ b/netx/net/sourceforge/jnlp/tools/JarSigner.java Mon Oct 25 14:15:45 2010 -0400
> @@ -25,6 +25,8 @@
>
> package net.sourceforge.jnlp.tools;
>
> +import static net.sourceforge.jnlp.runtime.Translator.R;
> +
> import java.io.*;
> import java.util.*;
> import java.util.zip.*;
> @@ -40,7 +42,6 @@
>
> import net.sourceforge.jnlp.*;
> import net.sourceforge.jnlp.cache.*;
> -import net.sourceforge.jnlp.runtime.*;
> import net.sourceforge.jnlp.security.*;
>
> /**
> @@ -52,10 +53,6 @@
>
> public class JarSigner implements CertVerifier {
>
> - private static String R(String key) {
> - return JNLPRuntime.getMessage(key);
> - }
> -
> private static final Collator collator = Collator.getInstance();
> static {
> // this is for case insensitive string comparisions
More information about the distro-pkg-dev
mailing list