git.gag.com Git - debian/openrocket/blob - src/net/sf/openrocket/l10n/Translator.java

   1 package net.sf.openrocket.l10n;
   2
   3 /**
   4  * An interface for obtaining translations from logical keys.
   5  * <p>
   6  * Translator implementations must be thread-safe.
   7  *
   8  * @author Sampo Niskanen <sampo.niskanen@iki.fi>
   9  */
  10 public interface Translator {
  11
  12         /**
  13          * Retrieve a translated string based on a logical key.  This always returns
  14          * some string, potentially falling back to the key itself.
  15          *
  16          * @param key   the logical string key.
  17          * @return              the translated string.
  18          * @throws NullPointerException if key is null.
  19          */
  20         public String get(String key);
  21
  22 }