Add DiscordLocale#toLocale (#2485)

discord-jda · Aug 10, 2023 · 77c626e · 77c626e
1 parent c0582c5
commit 77c626e
Showing 1 changed file with 18 additions and 0 deletions.
diff --git a/src/main/java/net/dv8tion/jda/api/interactions/DiscordLocale.java b/src/main/java/net/dv8tion/jda/api/interactions/DiscordLocale.java
@@ -83,6 +83,24 @@ public String getLocale()
         return locale;
     }
 
+    /**
+     * Creates a {@link Locale} from this DiscordLocale.
+     * <br>This is a simple shortcut to {@link Locale#forLanguageTag(String) Locale.forLanguageTag(getLocale())}.
+     *
+     * <p><b>Note:</b> The returned {@link Locale} might not be the same locale
+     * as the one passed in {@link #from(Locale) DiscordLocale#from(Locale)}.
+     * See {@link Locale#forLanguageTag(String)} for more details.
+     *
+     * @return the {@link Locale} from this DiscordLocale
+     *
+     * @see    Locale#forLanguageTag(String)
+     */
+    @Nonnull
+    public Locale toLocale()
+    {
+        return Locale.forLanguageTag(getLocale());
+    }
+
     /**
      * The language's human-readable name, in English.
      *