Merge pull request #1114 from apache/feature/WW-5482-locale

lukaszlenart · web-flow · commit 7fc0c41b1ebc · 2024-11-03T14:41:15.000+01:00
WW-5482 Extract locale related classes into org.apache.struts2.locale
diff --git a/core/src/main/java/org/apache/struts2/ActionSupport.java b/core/src/main/java/org/apache/struts2/ActionSupport.java
@@ -25,6 +25,8 @@
 import org.apache.struts2.inject.Container;
 import org.apache.struts2.inject.Inject;
 import org.apache.struts2.interceptor.ValidationAware;
+import org.apache.struts2.locale.LocaleProvider;
+import org.apache.struts2.locale.LocaleProviderFactory;
 import org.apache.struts2.text.TextProvider;
 import org.apache.struts2.text.TextProviderFactory;
 import org.apache.struts2.util.ValueStack;
diff --git a/core/src/main/java/org/apache/struts2/StrutsConstants.java b/core/src/main/java/org/apache/struts2/StrutsConstants.java
diff --git a/core/src/main/java/org/apache/struts2/components/I18n.java b/core/src/main/java/org/apache/struts2/components/I18n.java
@@ -21,14 +21,14 @@
 import java.io.Writer;
 import java.util.ResourceBundle;
 
-import org.apache.struts2.LocaleProviderFactory;
+import org.apache.struts2.locale.LocaleProviderFactory;
 import org.apache.struts2.text.LocalizedTextProvider;
 import org.apache.struts2.text.TextProviderFactory;
 import org.apache.struts2.views.annotations.StrutsTag;
 import org.apache.struts2.views.annotations.StrutsTagAttribute;
 import org.apache.struts2.StrutsException;
 
-import org.apache.struts2.LocaleProvider;
+import org.apache.struts2.locale.LocaleProvider;
 import org.apache.struts2.text.TextProvider;
 import org.apache.struts2.inject.Inject;
 import org.apache.struts2.util.ValueStack;
diff --git a/core/src/main/java/org/apache/struts2/config/StrutsBeanSelectionProvider.java b/core/src/main/java/org/apache/struts2/config/StrutsBeanSelectionProvider.java
@@ -22,7 +22,7 @@
 import org.apache.struts2.ActionProxyFactory;
 import org.apache.struts2.FileManager;
 import org.apache.struts2.FileManagerFactory;
-import org.apache.struts2.LocaleProviderFactory;
+import org.apache.struts2.locale.LocaleProviderFactory;
 import org.apache.struts2.text.LocalizedTextProvider;
 import org.apache.struts2.ObjectFactory;
 import org.apache.struts2.StrutsConstants;
diff --git a/core/src/main/java/org/apache/struts2/config/impl/DefaultConfiguration.java b/core/src/main/java/org/apache/struts2/config/impl/DefaultConfiguration.java
@@ -19,11 +19,11 @@
 package org.apache.struts2.config.impl;
 
 import org.apache.struts2.ActionContext;
-import org.apache.struts2.DefaultLocaleProviderFactory;
+import org.apache.struts2.locale.DefaultLocaleProviderFactory;
 import org.apache.struts2.text.DefaultTextProvider;
 import org.apache.struts2.FileManager;
 import org.apache.struts2.FileManagerFactory;
-import org.apache.struts2.LocaleProviderFactory;
+import org.apache.struts2.locale.LocaleProviderFactory;
 import org.apache.struts2.text.LocalizedTextProvider;
 import org.apache.struts2.ObjectFactory;
 import org.apache.struts2.text.StrutsTextProviderFactory;
diff --git a/core/src/main/java/org/apache/struts2/conversion/impl/DefaultTypeConverter.java b/core/src/main/java/org/apache/struts2/conversion/impl/DefaultTypeConverter.java
@@ -19,7 +19,7 @@
 package org.apache.struts2.conversion.impl;
 
 import org.apache.struts2.ActionContext;
-import org.apache.struts2.LocaleProviderFactory;
+import org.apache.struts2.locale.LocaleProviderFactory;
 import org.apache.struts2.conversion.TypeConverter;
 import org.apache.struts2.inject.Container;
 import org.apache.struts2.inject.Inject;
diff --git a/core/src/main/java/org/apache/struts2/dispatcher/Dispatcher.java b/core/src/main/java/org/apache/struts2/dispatcher/Dispatcher.java
@@ -34,7 +34,7 @@
 import org.apache.struts2.ActionProxyFactory;
 import org.apache.struts2.FileManager;
 import org.apache.struts2.FileManagerFactory;
-import org.apache.struts2.LocaleProviderFactory;
+import org.apache.struts2.locale.LocaleProviderFactory;
 import org.apache.struts2.ObjectFactory;
 import org.apache.struts2.ServletActionContext;
 import org.apache.struts2.StrutsConstants;
diff --git a/core/src/main/java/org/apache/struts2/dispatcher/multipart/MultiPartRequestWrapper.java b/core/src/main/java/org/apache/struts2/dispatcher/multipart/MultiPartRequestWrapper.java
@@ -18,7 +18,7 @@
  */
 package org.apache.struts2.dispatcher.multipart;
 
-import org.apache.struts2.LocaleProvider;
+import org.apache.struts2.locale.LocaleProvider;
 import org.apache.logging.log4j.LogManager;
 import org.apache.logging.log4j.Logger;
 import org.apache.struts2.dispatcher.LocalizedMessage;
diff --git a/core/src/main/java/org/apache/struts2/interceptor/AbstractFileUploadInterceptor.java b/core/src/main/java/org/apache/struts2/interceptor/AbstractFileUploadInterceptor.java
@@ -18,8 +18,8 @@
  */
 package org.apache.struts2.interceptor;
 
-import org.apache.struts2.LocaleProvider;
-import org.apache.struts2.LocaleProviderFactory;
+import org.apache.struts2.locale.LocaleProvider;
+import org.apache.struts2.locale.LocaleProviderFactory;
 import org.apache.struts2.text.TextProvider;
 import org.apache.struts2.text.TextProviderFactory;
 import org.apache.struts2.inject.Container;
diff --git a/core/src/main/java/org/apache/struts2/interceptor/I18nInterceptor.java b/core/src/main/java/org/apache/struts2/interceptor/I18nInterceptor.java
@@ -19,10 +19,9 @@
 package org.apache.struts2.interceptor;
 
 import org.apache.struts2.ActionInvocation;
-import org.apache.struts2.LocaleProvider;
-import org.apache.struts2.LocaleProviderFactory;
+import org.apache.struts2.locale.LocaleProvider;
+import org.apache.struts2.locale.LocaleProviderFactory;
 import org.apache.struts2.inject.Inject;
-import org.apache.struts2.interceptor.AbstractInterceptor;
 import org.apache.struts2.util.TextParseUtil;
 import org.apache.logging.log4j.LogManager;
 import org.apache.logging.log4j.Logger;
diff --git a/core/src/main/java/org/apache/struts2/locale/DefaultLocaleProvider.java b/core/src/main/java/org/apache/struts2/locale/DefaultLocaleProvider.java
@@ -16,13 +16,14 @@
  * specific language governing permissions and limitations
  * under the License.
  */
-package org.apache.struts2;
+package org.apache.struts2.locale;
 
 import org.apache.commons.lang3.LocaleUtils;
 import org.apache.commons.lang3.StringUtils;
 import org.apache.logging.log4j.LogManager;
 import org.apache.logging.log4j.Logger;
 import org.apache.logging.log4j.message.ParameterizedMessage;
+import org.apache.struts2.ActionContext;
 
 import java.util.Locale;
 
diff --git a/core/src/main/java/org/apache/struts2/locale/DefaultLocaleProviderFactory.java b/core/src/main/java/org/apache/struts2/locale/DefaultLocaleProviderFactory.java
@@ -16,7 +16,7 @@
  * specific language governing permissions and limitations
  * under the License.
  */
-package org.apache.struts2;
+package org.apache.struts2.locale;
 
 public class DefaultLocaleProviderFactory implements LocaleProviderFactory {
 
diff --git a/core/src/main/java/org/apache/struts2/locale/LocaleProvider.java b/core/src/main/java/org/apache/struts2/locale/LocaleProvider.java
@@ -16,7 +16,7 @@
  * specific language governing permissions and limitations
  * under the License.
  */
-package org.apache.struts2;
+package org.apache.struts2.locale;
 
 import org.apache.commons.lang3.LocaleUtils;
 import org.apache.commons.lang3.StringUtils;
@@ -25,22 +25,18 @@
 
 /**
  * Indicates that the implementing class can provide its own {@link Locale}.
- *
  * <p>
  * This is useful for when an action may wish override the default locale. All that is
  * needed is to implement this interface and return your own custom locale.
  * The {@link org.apache.struts2.text.TextProvider} interface uses this interface
  * heavily for retrieving internationalized messages from resource bundles.
- * </p>
- *
- * @author Jason Carreira
  */
 public interface LocaleProvider {
 
     /**
      * Gets the provided locale.
      *
-     * @return  the locale.
+     * @return the locale.
      */
     Locale getLocale();
 
@@ -62,6 +58,7 @@ public interface LocaleProvider {
 
     /**
      * Tries to convert provided locale string into {@link Locale} or returns null
+     *
      * @param localeStr a String representing locale, e.g.: en_EN
      * @return instance of {@link Locale} or null
      * @since Struts 6.5.0
diff --git a/core/src/main/java/org/apache/struts2/locale/LocaleProviderFactory.java b/core/src/main/java/org/apache/struts2/locale/LocaleProviderFactory.java
@@ -16,7 +16,9 @@
  * specific language governing permissions and limitations
  * under the License.
  */
-package org.apache.struts2;
+package org.apache.struts2.locale;
+
+import org.apache.struts2.ActionSupport;
 
 /**
  * Allows delegate creation of {@link LocaleProvider} to another implementation provided
diff --git a/core/src/main/java/org/apache/struts2/text/ResourceBundleTextProvider.java b/core/src/main/java/org/apache/struts2/text/ResourceBundleTextProvider.java
@@ -18,7 +18,7 @@
  */
 package org.apache.struts2.text;
 
-import org.apache.struts2.LocaleProvider;
+import org.apache.struts2.locale.LocaleProvider;
 
 import java.util.ResourceBundle;
 
diff --git a/core/src/main/java/org/apache/struts2/text/StrutsTextProviderFactory.java b/core/src/main/java/org/apache/struts2/text/StrutsTextProviderFactory.java
@@ -18,7 +18,7 @@
  */
 package org.apache.struts2.text;
 
-import org.apache.struts2.LocaleProviderFactory;
+import org.apache.struts2.locale.LocaleProviderFactory;
 import org.apache.struts2.inject.Inject;
 
 import java.util.ResourceBundle;
diff --git a/core/src/main/java/org/apache/struts2/text/TextProvider.java b/core/src/main/java/org/apache/struts2/text/TextProvider.java
@@ -18,6 +18,7 @@
  */
 package org.apache.struts2.text;
 
+import org.apache.struts2.locale.LocaleProvider;
 import org.apache.struts2.util.ValueStack;
 
 import java.util.List;
@@ -33,9 +34,9 @@
  * global texts to be defined for an application base class.
  *
  * <p>
- * You can override {@link org.apache.struts2.LocaleProvider#getLocale()} to change the behaviour of how
+ * You can override {@link LocaleProvider#getLocale()} to change the behaviour of how
  * to choose locale for the bundles that are returned. Typically you would
- * use the {@link org.apache.struts2.LocaleProvider} interface to get the users configured locale.
+ * use the {@link LocaleProvider} interface to get the users configured locale.
  * </p>
  *
  * <p>
@@ -56,7 +57,7 @@
  * </p>
  * @author Jason Carreira
  * @author Rainer Hermanns
- * @see org.apache.struts2.LocaleProvider
+ * @see LocaleProvider
  * @see TextProviderSupport
  */
 public interface TextProvider {
diff --git a/core/src/main/java/org/apache/struts2/text/TextProviderSupport.java b/core/src/main/java/org/apache/struts2/text/TextProviderSupport.java
@@ -18,8 +18,8 @@
  */
 package org.apache.struts2.text;
 
-import org.apache.struts2.LocaleProvider;
-import org.apache.struts2.LocaleProviderFactory;
+import org.apache.struts2.locale.LocaleProvider;
+import org.apache.struts2.locale.LocaleProviderFactory;
 import org.apache.struts2.inject.Inject;
 import org.apache.struts2.util.ValueStack;
 
diff --git a/core/src/main/java/org/apache/struts2/validator/DelegatingValidatorContext.java b/core/src/main/java/org/apache/struts2/validator/DelegatingValidatorContext.java
@@ -22,8 +22,8 @@
 import org.apache.logging.log4j.Logger;
 import org.apache.struts2.ActionContext;
 import org.apache.struts2.text.CompositeTextProvider;
-import org.apache.struts2.LocaleProvider;
-import org.apache.struts2.LocaleProviderFactory;
+import org.apache.struts2.locale.LocaleProvider;
+import org.apache.struts2.locale.LocaleProviderFactory;
 import org.apache.struts2.text.TextProvider;
 import org.apache.struts2.text.TextProviderFactory;
 import org.apache.struts2.interceptor.ValidationAware;
diff --git a/core/src/main/java/org/apache/struts2/validator/ValidatorContext.java b/core/src/main/java/org/apache/struts2/validator/ValidatorContext.java
@@ -18,7 +18,7 @@
  */
 package org.apache.struts2.validator;
 
-import org.apache.struts2.LocaleProvider;
+import org.apache.struts2.locale.LocaleProvider;
 import org.apache.struts2.text.TextProvider;
 import org.apache.struts2.interceptor.ValidationAware;
 
diff --git a/core/src/main/java/org/apache/struts2/views/freemarker/FreemarkerResult.java b/core/src/main/java/org/apache/struts2/views/freemarker/FreemarkerResult.java
@@ -20,7 +20,7 @@
 
 import org.apache.struts2.ActionContext;
 import org.apache.struts2.ActionInvocation;
-import org.apache.struts2.LocaleProvider;
+import org.apache.struts2.locale.LocaleProvider;
 import org.apache.struts2.inject.Inject;
 import org.apache.struts2.util.ValueStack;
 import freemarker.template.Configuration;
diff --git a/core/src/main/resources/struts-beans.xml b/core/src/main/resources/struts-beans.xml
@@ -137,8 +137,8 @@
           scope="singleton"/>
     <bean type="org.apache.struts2.text.TextProviderFactory" name="struts"
           class="org.apache.struts2.text.StrutsTextProviderFactory" scope="singleton"/>
-    <bean type="org.apache.struts2.LocaleProviderFactory" name="struts"
-          class="org.apache.struts2.DefaultLocaleProviderFactory" scope="singleton"/>
+    <bean type="org.apache.struts2.locale.LocaleProviderFactory" name="struts"
+          class="org.apache.struts2.locale.DefaultLocaleProviderFactory" scope="singleton"/>
 
     <bean type="org.apache.struts2.components.UrlRenderer" name="struts"
           class="org.apache.struts2.components.ServletUrlRenderer"/>
diff --git a/core/src/test/java/org/apache/struts2/LocaleProviderTest.java b/core/src/test/java/org/apache/struts2/LocaleProviderTest.java
@@ -18,6 +18,7 @@
  */
 package org.apache.struts2;
 
+import org.apache.struts2.locale.LocaleProvider;
 import org.junit.Test;
 
 import java.util.Locale;
diff --git a/core/src/test/java/org/apache/struts2/config/providers/ConfigurationProviderOgnlAllowlistTest.java b/core/src/test/java/org/apache/struts2/config/providers/ConfigurationProviderOgnlAllowlistTest.java
@@ -46,7 +46,7 @@ public void allowList() throws Exception {
 
         assertThat(providerAllowlist.getProviderAllowlist()).containsExactlyInAnyOrder(
                 Class.forName("org.apache.struts2.interceptor.ValidationAware"),
-                Class.forName("org.apache.struts2.LocaleProvider"),
+                Class.forName("org.apache.struts2.locale.LocaleProvider"),
                 Class.forName("java.io.Serializable"),
                 Class.forName("org.apache.struts2.mock.MockResult"),
                 Class.forName("org.apache.struts2.interceptor.ConditionalInterceptor"),
@@ -72,7 +72,7 @@ public void allowlist_1only() throws Exception {
 
         assertThat(providerAllowlist.getProviderAllowlist()).containsExactlyInAnyOrder(
                 Class.forName("org.apache.struts2.interceptor.ValidationAware"),
-                Class.forName("org.apache.struts2.LocaleProvider"),
+                Class.forName("org.apache.struts2.locale.LocaleProvider"),
                 Class.forName("java.io.Serializable"),
                 Class.forName("org.apache.struts2.mock.MockResult"),
                 Class.forName("org.apache.struts2.interceptor.ConditionalInterceptor"),
@@ -96,7 +96,7 @@ public void allowlist_2only() throws Exception {
 
         assertThat(providerAllowlist.getProviderAllowlist()).containsExactlyInAnyOrder(
                 Class.forName("org.apache.struts2.interceptor.ValidationAware"),
-                Class.forName("org.apache.struts2.LocaleProvider"),
+                Class.forName("org.apache.struts2.locale.LocaleProvider"),
                 Class.forName("java.io.Serializable"),
                 Class.forName("org.apache.struts2.interceptor.ConditionalInterceptor"),
                 Class.forName("org.apache.struts2.ActionSupport"),
diff --git a/core/src/test/java/org/apache/struts2/interceptor/ActionFileUploadInterceptorTest.java b/core/src/test/java/org/apache/struts2/interceptor/ActionFileUploadInterceptorTest.java
@@ -20,7 +20,7 @@
 
 import org.apache.struts2.ActionContext;
 import org.apache.struts2.ActionSupport;
-import org.apache.struts2.DefaultLocaleProvider;
+import org.apache.struts2.locale.DefaultLocaleProvider;
 import org.apache.struts2.ValidationAwareSupport;
 import org.apache.struts2.mock.MockActionInvocation;
 import org.apache.struts2.mock.MockActionProxy;
diff --git a/core/src/test/java/org/apache/struts2/interceptor/I18nInterceptorTest.java b/core/src/test/java/org/apache/struts2/interceptor/I18nInterceptorTest.java
@@ -21,7 +21,7 @@
 import org.apache.struts2.action.Action;
 import org.apache.struts2.ActionContext;
 import org.apache.struts2.ActionInvocation;
-import org.apache.struts2.DefaultLocaleProviderFactory;
+import org.apache.struts2.locale.DefaultLocaleProviderFactory;
 import org.apache.struts2.mock.MockActionInvocation;
 import org.apache.struts2.mock.MockActionProxy;
 import junit.framework.TestCase;
diff --git a/core/src/test/java/org/apache/struts2/locale/DefaultLocaleProviderTest.java b/core/src/test/java/org/apache/struts2/locale/DefaultLocaleProviderTest.java
@@ -16,8 +16,9 @@
  * specific language governing permissions and limitations
  * under the License.
  */
-package org.apache.struts2;
+package org.apache.struts2.locale;
 
+import org.apache.struts2.ActionContext;
 import org.junit.AfterClass;
 import org.junit.Before;
 import org.junit.BeforeClass;
diff --git a/core/src/test/java/org/apache/struts2/text/TextProviderSupportTest.java b/core/src/test/java/org/apache/struts2/text/TextProviderSupportTest.java
@@ -18,7 +18,7 @@
  */
 package org.apache.struts2.text;
 
-import org.apache.struts2.LocaleProvider;
+import org.apache.struts2.locale.LocaleProvider;
 import org.apache.struts2.XWorkTestCase;
 
 import java.util.ArrayList;
diff --git a/plugins/tiles/src/main/java/org/apache/struts2/tiles/StrutsTilesLocaleResolver.java b/plugins/tiles/src/main/java/org/apache/struts2/tiles/StrutsTilesLocaleResolver.java
@@ -19,7 +19,7 @@
 package org.apache.struts2.tiles;
 
 import org.apache.struts2.ActionContext;
-import org.apache.struts2.LocaleProviderFactory;
+import org.apache.struts2.locale.LocaleProviderFactory;
 import org.apache.struts2.config.ConfigurationException;
 import org.apache.logging.log4j.LogManager;
 import org.apache.logging.log4j.Logger;
