Interface Translator

    • Method Summary

      All Methods Static Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      @NotNull Key name()
      A key identifying this translation source.
      static @Nullable java.util.Locale parseLocale​(@NotNull java.lang.String string)
      Parses a Locale from a String.
      @Nullable java.text.MessageFormat translate​(@NotNull java.lang.String key, @NotNull java.util.Locale locale)
      Gets a message format from a key and locale.
    • Method Detail

      • parseLocale

        @Nullable
        static @Nullable java.util.Locale parseLocale​(@NotNull
                                                      @NotNull java.lang.String string)
        Parses a Locale from a String.
        Parameters:
        string - the string
        Returns:
        a locale
        Since:
        4.0.0
      • name

        @NotNull
        @NotNull Key name()
        A key identifying this translation source.

        Intended to be used for display to users.

        Returns:
        an identifier for this translation source
        Since:
        4.0.0
      • translate

        @Nullable
        @Nullable java.text.MessageFormat translate​(@NotNull
                                                    @NotNull java.lang.String key,
                                                    @NotNull
                                                    @NotNull java.util.Locale locale)
        Gets a message format from a key and locale.
        Parameters:
        locale - a locale
        key - a translation key
        Returns:
        a message format or null to skip translation
        Since:
        4.0.0