This is an automated email from the ASF dual-hosted git repository.
kusal pushed a commit to branch kusal-depr-apis-5
in repository https://gitbox.apache.org/repos/asf/struts.git
The following commit(s) were added to refs/heads/kusal-depr-apis-5 by this push:
new 07ca408f4 WW-3714 Deprecate and migrate assorted marker interfaces
07ca408f4 is described below
commit 07ca408f448f4911eb86ff318ab3fc122eee8df4
Author: Kusal Kithul-Godage <g...@kusal.io>
AuthorDate: Thu Oct 17 16:12:01 2024 +1100
WW-3714 Deprecate and migrate assorted marker interfaces
---
.../java/com/opensymphony/xwork2/ModelDriven.java | 16 +--
.../java/com/opensymphony/xwork2/Preparable.java | 17 +---
.../java/com/opensymphony/xwork2/Unchainable.java | 7 +-
.../java/com/opensymphony/xwork2/Validateable.java | 15 +--
.../xwork2/interceptor/ScopedModelDriven.java | 21 +---
.../xwork2/interceptor/ValidationAware.java | 111 +--------------------
.../xwork2/interceptor/ValidationErrorAware.java | 20 +---
.../interceptor/ValidationWorkflowAware.java | 10 +-
.../xwork2 => org/apache/struts2}/ModelDriven.java | 2 +-
.../xwork2 => org/apache/struts2}/Preparable.java | 4 +-
.../xwork2 => org/apache/struts2}/Unchainable.java | 2 +-
.../apache/struts2}/Validateable.java | 4 +-
.../struts2}/interceptor/ScopedModelDriven.java | 8 +-
.../struts2}/interceptor/ValidationAware.java | 2 +-
.../struts2}/interceptor/ValidationErrorAware.java | 2 +-
.../interceptor/ValidationWorkflowAware.java | 2 +-
16 files changed, 37 insertions(+), 206 deletions(-)
diff --git a/core/src/main/java/com/opensymphony/xwork2/ModelDriven.java
b/core/src/main/java/com/opensymphony/xwork2/ModelDriven.java
index c07c6bbe7..f3ae25cab 100644
--- a/core/src/main/java/com/opensymphony/xwork2/ModelDriven.java
+++ b/core/src/main/java/com/opensymphony/xwork2/ModelDriven.java
@@ -19,18 +19,8 @@
package com.opensymphony.xwork2;
/**
- * ModelDriven Actions provide a model object to be pushed onto the ValueStack
- * in addition to the Action itself, allowing a FormBean type approach like
Struts.
- *
- * @author Jason Carreira
+ * @deprecated since 6.7.0, use {@link org.apache.struts2.ModelDriven} instead.
*/
-public interface ModelDriven<T> {
-
- /**
- * Gets the model to be pushed onto the ValueStack instead of the Action
itself.
- *
- * @return the model
- */
- T getModel();
-
+@Deprecated
+public interface ModelDriven<T> extends org.apache.struts2.ModelDriven<T> {
}
diff --git a/core/src/main/java/com/opensymphony/xwork2/Preparable.java
b/core/src/main/java/com/opensymphony/xwork2/Preparable.java
index 23fdf68ae..2c03088e8 100644
--- a/core/src/main/java/com/opensymphony/xwork2/Preparable.java
+++ b/core/src/main/java/com/opensymphony/xwork2/Preparable.java
@@ -19,19 +19,8 @@
package com.opensymphony.xwork2;
/**
- * Preparable Actions will have their <code>prepare()</code> method called if
the {@link com.opensymphony.xwork2.interceptor.PrepareInterceptor}
- * is applied to the ActionConfig.
- *
- * @author Jason Carreira
- * @see com.opensymphony.xwork2.interceptor.PrepareInterceptor
+ * @deprecated since 6.7.0, use {@link org.apache.struts2.Preparable} instead.
*/
-public interface Preparable {
-
- /**
- * This method is called to allow the action to prepare itself.
- *
- * @throws Exception thrown if a system level exception occurs.
- */
- void prepare() throws Exception;
-
+@Deprecated
+public interface Preparable extends org.apache.struts2.Preparable {
}
diff --git a/core/src/main/java/com/opensymphony/xwork2/Unchainable.java
b/core/src/main/java/com/opensymphony/xwork2/Unchainable.java
index 9f96b92dc..506f4f283 100644
--- a/core/src/main/java/com/opensymphony/xwork2/Unchainable.java
+++ b/core/src/main/java/com/opensymphony/xwork2/Unchainable.java
@@ -19,9 +19,8 @@
package com.opensymphony.xwork2;
/**
- * Simple marker interface to indicate an object should <b>not</b> have its
properties copied during chaining.
- *
- * @see com.opensymphony.xwork2.interceptor.ChainingInterceptor
+ * @deprecated since 6.7.0, use {@link org.apache.struts2.Unchainable} instead.
*/
-public interface Unchainable {
+@Deprecated
+public interface Unchainable extends org.apache.struts2.Unchainable {
}
diff --git a/core/src/main/java/com/opensymphony/xwork2/Validateable.java
b/core/src/main/java/com/opensymphony/xwork2/Validateable.java
index ed7226380..c92170e73 100644
--- a/core/src/main/java/com/opensymphony/xwork2/Validateable.java
+++ b/core/src/main/java/com/opensymphony/xwork2/Validateable.java
@@ -19,17 +19,8 @@
package com.opensymphony.xwork2;
/**
- * Provides an interface in which a call for a validation check can be done.
- *
- * @author Jason Carreira
- * @see ActionSupport
- * @see com.opensymphony.xwork2.interceptor.DefaultWorkflowInterceptor
+ * @deprecated since 6.7.0, use {@link org.apache.struts2.Validateable}
instead.
*/
-public interface Validateable {
-
- /**
- * Performs validation.
- */
- void validate();
-
+@Deprecated
+public interface Validateable extends org.apache.struts2.Validateable {
}
diff --git
a/core/src/main/java/com/opensymphony/xwork2/interceptor/ScopedModelDriven.java
b/core/src/main/java/com/opensymphony/xwork2/interceptor/ScopedModelDriven.java
index 42ddb09b3..d5413b4e5 100644
---
a/core/src/main/java/com/opensymphony/xwork2/interceptor/ScopedModelDriven.java
+++
b/core/src/main/java/com/opensymphony/xwork2/interceptor/ScopedModelDriven.java
@@ -21,23 +21,8 @@ package com.opensymphony.xwork2.interceptor;
import com.opensymphony.xwork2.ModelDriven;
/**
- * Adds the ability to set a model, probably retrieved from a given state.
+ * @deprecated since 6.7.0, use {@link
org.apache.struts2.interceptor.ScopedModelDriven} instead.
*/
-public interface ScopedModelDriven<T> extends ModelDriven<T> {
-
- /**
- * @param model sets the model
- */
- void setModel(T model);
-
- /**
- * Sets the key under which the model is stored
- * @param key The model key
- */
- void setScopeKey(String key);
-
- /**
- * @return the key under which the model is stored
- */
- String getScopeKey();
+@Deprecated
+public interface ScopedModelDriven<T> extends
org.apache.struts2.interceptor.ScopedModelDriven<T>, ModelDriven<T> {
}
diff --git
a/core/src/main/java/com/opensymphony/xwork2/interceptor/ValidationAware.java
b/core/src/main/java/com/opensymphony/xwork2/interceptor/ValidationAware.java
index 485cb42fb..c959f19d7 100644
---
a/core/src/main/java/com/opensymphony/xwork2/interceptor/ValidationAware.java
+++
b/core/src/main/java/com/opensymphony/xwork2/interceptor/ValidationAware.java
@@ -18,114 +18,9 @@
*/
package com.opensymphony.xwork2.interceptor;
-import java.util.Collection;
-import java.util.List;
-import java.util.Map;
-
/**
- * ValidationAware classes can accept Action (class level) or field level
error messages. Action level messages are kept
- * in a Collection. Field level error messages are kept in a Map from String
field name to a List of field error msgs.
+ * @deprecated since 6.7.0, use {@link
org.apache.struts2.interceptor.ValidationAware} instead.
*/
-public interface ValidationAware {
-
- /**
- * Set the Collection of Action-level String error messages.
- *
- * @param errorMessages Collection of String error messages
- */
- void setActionErrors(Collection<String> errorMessages);
-
- /**
- * Get the Collection of Action-level error messages for this action.
Error messages should not
- * be added directly here, as implementations are free to return a new
Collection or an
- * Unmodifiable Collection.
- *
- * @return Collection of String error messages
- */
- Collection<String> getActionErrors();
-
- /**
- * Set the Collection of Action-level String messages (not errors).
- *
- * @param messages Collection of String messages (not errors).
- */
- void setActionMessages(Collection<String> messages);
-
- /**
- * Get the Collection of Action-level messages for this action. Messages
should not be added
- * directly here, as implementations are free to return a new Collection
or an Unmodifiable
- * Collection.
- *
- * @return Collection of String messages
- */
- Collection<String> getActionMessages();
-
- /**
- * Set the field error map of fieldname (String) to Collection of String
error messages.
- *
- * @param errorMap field error map
- */
- void setFieldErrors(Map<String, List<String>> errorMap);
-
- /**
- * Get the field specific errors associated with this action. Error
messages should not be added
- * directly here, as implementations are free to return a new Collection
or an Unmodifiable
- * Collection.
- *
- * @return Map with errors mapped from fieldname (String) to Collection of
String error messages
- */
- Map<String, List<String>> getFieldErrors();
-
- /**
- * Add an Action-level error message to this Action.
- *
- * @param anErrorMessage the error message
- */
- void addActionError(String anErrorMessage);
-
- /**
- * Add an Action-level message to this Action.
- *
- * @param aMessage the message
- */
- void addActionMessage(String aMessage);
-
- /**
- * Add an error message for a given field.
- *
- * @param fieldName name of field
- * @param errorMessage the error message
- */
- void addFieldError(String fieldName, String errorMessage);
-
- /**
- * Check whether there are any Action-level error messages.
- *
- * @return true if any Action-level error messages have been registered
- */
- boolean hasActionErrors();
-
- /**
- * Checks whether there are any Action-level messages.
- *
- * @return true if any Action-level messages have been registered
- */
- boolean hasActionMessages();
-
- /**
- * Checks whether there are any action errors or field errors.
- *
- * @return <code>(hasActionErrors() || hasFieldErrors())</code>
- */
- default boolean hasErrors() {
- return hasActionErrors() || hasFieldErrors();
- }
-
- /**
- * Check whether there are any field errors associated with this action.
- *
- * @return whether there are any field errors
- */
- boolean hasFieldErrors();
-
+@Deprecated
+public interface ValidationAware extends
org.apache.struts2.interceptor.ValidationAware {
}
diff --git
a/core/src/main/java/com/opensymphony/xwork2/interceptor/ValidationErrorAware.java
b/core/src/main/java/com/opensymphony/xwork2/interceptor/ValidationErrorAware.java
index 4d04fa6dc..184cf1339 100644
---
a/core/src/main/java/com/opensymphony/xwork2/interceptor/ValidationErrorAware.java
+++
b/core/src/main/java/com/opensymphony/xwork2/interceptor/ValidationErrorAware.java
@@ -19,22 +19,8 @@
package com.opensymphony.xwork2.interceptor;
/**
- * ValidationErrorAware classes can be notified about validation errors
- * before {@link
com.opensymphony.xwork2.interceptor.DefaultWorkflowInterceptor} will return
'inputResultName' result
- * to allow change or not the result name
- *
- * This interface can be only applied to action which already implements
{@link ValidationAware} interface!
- *
- * @since 2.3.15
+ * @deprecated since 6.7.0, use {@link
org.apache.struts2.interceptor.ValidationErrorAware} instead.
*/
-public interface ValidationErrorAware {
-
- /**
- * Allows to notify action about occurred action/field errors
- *
- * @param currentResultName current result name, action can change it or
return the same
- * @return new result name or passed currentResultName
- */
- String actionErrorOccurred(final String currentResultName);
-
+@Deprecated
+public interface ValidationErrorAware extends
org.apache.struts2.interceptor.ValidationErrorAware {
}
diff --git
a/core/src/main/java/com/opensymphony/xwork2/interceptor/ValidationWorkflowAware.java
b/core/src/main/java/com/opensymphony/xwork2/interceptor/ValidationWorkflowAware.java
index b6c25ed31..fc0218d43 100644
---
a/core/src/main/java/com/opensymphony/xwork2/interceptor/ValidationWorkflowAware.java
+++
b/core/src/main/java/com/opensymphony/xwork2/interceptor/ValidationWorkflowAware.java
@@ -19,12 +19,8 @@
package com.opensymphony.xwork2.interceptor;
/**
- * ValidationWorkflowAware classes can programmatically change result name
when errors occurred
- *
- * This interface can be only applied to action which already implements
{@link ValidationAware} interface!
+ * @deprecated since 6.7.0, use {@link
org.apache.struts2.interceptor.ValidationWorkflowAware} instead.
*/
-public interface ValidationWorkflowAware {
-
- String getInputResultName();
-
+@Deprecated
+public interface ValidationWorkflowAware extends
org.apache.struts2.interceptor.ValidationWorkflowAware {
}
diff --git a/core/src/main/java/com/opensymphony/xwork2/ModelDriven.java
b/core/src/main/java/org/apache/struts2/ModelDriven.java
similarity index 97%
copy from core/src/main/java/com/opensymphony/xwork2/ModelDriven.java
copy to core/src/main/java/org/apache/struts2/ModelDriven.java
index c07c6bbe7..0704109f1 100644
--- a/core/src/main/java/com/opensymphony/xwork2/ModelDriven.java
+++ b/core/src/main/java/org/apache/struts2/ModelDriven.java
@@ -16,7 +16,7 @@
* specific language governing permissions and limitations
* under the License.
*/
-package com.opensymphony.xwork2;
+package org.apache.struts2;
/**
* ModelDriven Actions provide a model object to be pushed onto the ValueStack
diff --git a/core/src/main/java/com/opensymphony/xwork2/Preparable.java
b/core/src/main/java/org/apache/struts2/Preparable.java
similarity index 97%
copy from core/src/main/java/com/opensymphony/xwork2/Preparable.java
copy to core/src/main/java/org/apache/struts2/Preparable.java
index 23fdf68ae..70b0f464d 100644
--- a/core/src/main/java/com/opensymphony/xwork2/Preparable.java
+++ b/core/src/main/java/org/apache/struts2/Preparable.java
@@ -16,7 +16,7 @@
* specific language governing permissions and limitations
* under the License.
*/
-package com.opensymphony.xwork2;
+package org.apache.struts2;
/**
* Preparable Actions will have their <code>prepare()</code> method called if
the {@link com.opensymphony.xwork2.interceptor.PrepareInterceptor}
@@ -33,5 +33,5 @@ public interface Preparable {
* @throws Exception thrown if a system level exception occurs.
*/
void prepare() throws Exception;
-
+
}
diff --git a/core/src/main/java/com/opensymphony/xwork2/Unchainable.java
b/core/src/main/java/org/apache/struts2/Unchainable.java
similarity index 96%
copy from core/src/main/java/com/opensymphony/xwork2/Unchainable.java
copy to core/src/main/java/org/apache/struts2/Unchainable.java
index 9f96b92dc..02e010142 100644
--- a/core/src/main/java/com/opensymphony/xwork2/Unchainable.java
+++ b/core/src/main/java/org/apache/struts2/Unchainable.java
@@ -16,7 +16,7 @@
* specific language governing permissions and limitations
* under the License.
*/
-package com.opensymphony.xwork2;
+package org.apache.struts2;
/**
* Simple marker interface to indicate an object should <b>not</b> have its
properties copied during chaining.
diff --git a/core/src/main/java/com/opensymphony/xwork2/Validateable.java
b/core/src/main/java/org/apache/struts2/Validateable.java
similarity index 93%
copy from core/src/main/java/com/opensymphony/xwork2/Validateable.java
copy to core/src/main/java/org/apache/struts2/Validateable.java
index ed7226380..d563e7905 100644
--- a/core/src/main/java/com/opensymphony/xwork2/Validateable.java
+++ b/core/src/main/java/org/apache/struts2/Validateable.java
@@ -16,13 +16,13 @@
* specific language governing permissions and limitations
* under the License.
*/
-package com.opensymphony.xwork2;
+package org.apache.struts2;
/**
* Provides an interface in which a call for a validation check can be done.
*
* @author Jason Carreira
- * @see ActionSupport
+ * @see com.opensymphony.xwork2.ActionSupport
* @see com.opensymphony.xwork2.interceptor.DefaultWorkflowInterceptor
*/
public interface Validateable {
diff --git
a/core/src/main/java/com/opensymphony/xwork2/interceptor/ScopedModelDriven.java
b/core/src/main/java/org/apache/struts2/interceptor/ScopedModelDriven.java
similarity index 92%
copy from
core/src/main/java/com/opensymphony/xwork2/interceptor/ScopedModelDriven.java
copy to core/src/main/java/org/apache/struts2/interceptor/ScopedModelDriven.java
index 42ddb09b3..d18ef0880 100644
---
a/core/src/main/java/com/opensymphony/xwork2/interceptor/ScopedModelDriven.java
+++ b/core/src/main/java/org/apache/struts2/interceptor/ScopedModelDriven.java
@@ -16,9 +16,9 @@
* specific language governing permissions and limitations
* under the License.
*/
-package com.opensymphony.xwork2.interceptor;
+package org.apache.struts2.interceptor;
-import com.opensymphony.xwork2.ModelDriven;
+import org.apache.struts2.ModelDriven;
/**
* Adds the ability to set a model, probably retrieved from a given state.
@@ -29,13 +29,13 @@ public interface ScopedModelDriven<T> extends
ModelDriven<T> {
* @param model sets the model
*/
void setModel(T model);
-
+
/**
* Sets the key under which the model is stored
* @param key The model key
*/
void setScopeKey(String key);
-
+
/**
* @return the key under which the model is stored
*/
diff --git
a/core/src/main/java/com/opensymphony/xwork2/interceptor/ValidationAware.java
b/core/src/main/java/org/apache/struts2/interceptor/ValidationAware.java
similarity index 98%
copy from
core/src/main/java/com/opensymphony/xwork2/interceptor/ValidationAware.java
copy to core/src/main/java/org/apache/struts2/interceptor/ValidationAware.java
index 485cb42fb..a1e611a1c 100644
---
a/core/src/main/java/com/opensymphony/xwork2/interceptor/ValidationAware.java
+++ b/core/src/main/java/org/apache/struts2/interceptor/ValidationAware.java
@@ -16,7 +16,7 @@
* specific language governing permissions and limitations
* under the License.
*/
-package com.opensymphony.xwork2.interceptor;
+package org.apache.struts2.interceptor;
import java.util.Collection;
import java.util.List;
diff --git
a/core/src/main/java/com/opensymphony/xwork2/interceptor/ValidationErrorAware.java
b/core/src/main/java/org/apache/struts2/interceptor/ValidationErrorAware.java
similarity index 97%
copy from
core/src/main/java/com/opensymphony/xwork2/interceptor/ValidationErrorAware.java
copy to
core/src/main/java/org/apache/struts2/interceptor/ValidationErrorAware.java
index 4d04fa6dc..7722ed9ec 100644
---
a/core/src/main/java/com/opensymphony/xwork2/interceptor/ValidationErrorAware.java
+++
b/core/src/main/java/org/apache/struts2/interceptor/ValidationErrorAware.java
@@ -16,7 +16,7 @@
* specific language governing permissions and limitations
* under the License.
*/
-package com.opensymphony.xwork2.interceptor;
+package org.apache.struts2.interceptor;
/**
* ValidationErrorAware classes can be notified about validation errors
diff --git
a/core/src/main/java/com/opensymphony/xwork2/interceptor/ValidationWorkflowAware.java
b/core/src/main/java/org/apache/struts2/interceptor/ValidationWorkflowAware.java
similarity index 96%
copy from
core/src/main/java/com/opensymphony/xwork2/interceptor/ValidationWorkflowAware.java
copy to
core/src/main/java/org/apache/struts2/interceptor/ValidationWorkflowAware.java
index b6c25ed31..e3f4a4385 100644
---
a/core/src/main/java/com/opensymphony/xwork2/interceptor/ValidationWorkflowAware.java
+++
b/core/src/main/java/org/apache/struts2/interceptor/ValidationWorkflowAware.java
@@ -16,7 +16,7 @@
* specific language governing permissions and limitations
* under the License.
*/
-package com.opensymphony.xwork2.interceptor;
+package org.apache.struts2.interceptor;
/**
* ValidationWorkflowAware classes can programmatically change result name
when errors occurred
