src/main/kotlin/net/pterodactylus/sone/freenet/Translation.kt

   1 /**
   2  * Sone - Translation.kt - Copyright © 2019–2020 David ‘Bombe’ Roden
   3  *
   4  * This program is free software: you can redistribute it and/or modify
   5  * it under the terms of the GNU General Public License as published by
   6  * the Free Software Foundation, either version 3 of the License, or
   7  * (at your option) any later version.
   8  *
   9  * This program is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  * GNU General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU General Public License
  15  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  16  */
  17
  18 package net.pterodactylus.sone.freenet
  19
  20 import java.util.*
  21
  22 /**
  23  * Facade for Fred’s [freenet.l10n.BaseL10n] object.
  24  */
  25 interface Translation {
  26
  27         /** The currently selected locale. */
  28         val currentLocale: Locale
  29
  30         /**
  31          * Returns the translated string for the given key, defaulting to `""`.
  32          *
  33          * @param key The key to return the translated string for
  34          * @return The translated string, or `""` if there is no translation
  35          */
  36         fun translate(key: String): String
  37
  38 }