You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@struts.apache.org by lu...@apache.org on 2023/01/22 10:25:17 UTC
[struts] 15/15: Updates JavaDocs
This is an automated email from the ASF dual-hosted git repository.
lukaszlenart pushed a commit to branch http-interceptor
in repository https://gitbox.apache.org/repos/asf/struts.git
commit 650d33c81b2223f4dd0c452669f97905516b5230
Author: Lukasz Lenart <lu...@gmail.com>
AuthorDate: Sun Sep 21 22:16:09 2014 +0200
Updates JavaDocs
---
.../struts2/interceptor/httpmethod/AllowedHttpMethod.java | 2 +-
.../org/apache/struts2/interceptor/httpmethod/HttpDelete.java | 2 +-
.../org/apache/struts2/interceptor/httpmethod/HttpGet.java | 2 +-
.../apache/struts2/interceptor/httpmethod/HttpGetOrPost.java | 2 +-
.../org/apache/struts2/interceptor/httpmethod/HttpMethod.java | 2 +-
.../apache/struts2/interceptor/httpmethod/HttpMethodAware.java | 6 +++---
.../struts2/interceptor/httpmethod/HttpMethodInterceptor.java | 10 +++++++---
.../org/apache/struts2/interceptor/httpmethod/HttpPost.java | 2 +-
.../org/apache/struts2/interceptor/httpmethod/HttpPut.java | 2 +-
9 files changed, 17 insertions(+), 13 deletions(-)
diff --git a/core/src/main/java/org/apache/struts2/interceptor/httpmethod/AllowedHttpMethod.java b/core/src/main/java/org/apache/struts2/interceptor/httpmethod/AllowedHttpMethod.java
index 7438c457c..185932086 100644
--- a/core/src/main/java/org/apache/struts2/interceptor/httpmethod/AllowedHttpMethod.java
+++ b/core/src/main/java/org/apache/struts2/interceptor/httpmethod/AllowedHttpMethod.java
@@ -9,7 +9,7 @@ import java.lang.annotation.Target;
* Use this annotation to limit with what http method action or action's method can be called
*
* @see HttpMethodInterceptor
- * @since 2.3.18
+ * @since 2.5
*/
@Target({ElementType.METHOD, ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
diff --git a/core/src/main/java/org/apache/struts2/interceptor/httpmethod/HttpDelete.java b/core/src/main/java/org/apache/struts2/interceptor/httpmethod/HttpDelete.java
index 19ac1ea49..51dee4024 100644
--- a/core/src/main/java/org/apache/struts2/interceptor/httpmethod/HttpDelete.java
+++ b/core/src/main/java/org/apache/struts2/interceptor/httpmethod/HttpDelete.java
@@ -9,7 +9,7 @@ import java.lang.annotation.Target;
* Use this annotation to allow call action or action's method via DELETE request only
*
* @see org.apache.struts2.interceptor.httpmethod.HttpMethodInterceptor
- * @since 2.3.18
+ * @since 2.5
*/
@Target({ElementType.METHOD, ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
diff --git a/core/src/main/java/org/apache/struts2/interceptor/httpmethod/HttpGet.java b/core/src/main/java/org/apache/struts2/interceptor/httpmethod/HttpGet.java
index 893bee1d2..fa93bcfcc 100644
--- a/core/src/main/java/org/apache/struts2/interceptor/httpmethod/HttpGet.java
+++ b/core/src/main/java/org/apache/struts2/interceptor/httpmethod/HttpGet.java
@@ -9,7 +9,7 @@ import java.lang.annotation.Target;
* Use this annotation to allow call action or action's method via GET request only
*
* @see HttpMethodInterceptor
- * @since 2.3.18
+ * @since 2.5
*/
@Target({ElementType.METHOD, ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
diff --git a/core/src/main/java/org/apache/struts2/interceptor/httpmethod/HttpGetOrPost.java b/core/src/main/java/org/apache/struts2/interceptor/httpmethod/HttpGetOrPost.java
index f831fcb29..1f2c221a8 100644
--- a/core/src/main/java/org/apache/struts2/interceptor/httpmethod/HttpGetOrPost.java
+++ b/core/src/main/java/org/apache/struts2/interceptor/httpmethod/HttpGetOrPost.java
@@ -9,7 +9,7 @@ import java.lang.annotation.Target;
* Use this annotation to allow call action or action's method via GET or POST request only
*
* @see HttpMethodInterceptor
- * @since 2.3.18
+ * @since 2.5
*/
@Target({ElementType.METHOD, ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
diff --git a/core/src/main/java/org/apache/struts2/interceptor/httpmethod/HttpMethod.java b/core/src/main/java/org/apache/struts2/interceptor/httpmethod/HttpMethod.java
index e1437f4bd..0467ffc4f 100644
--- a/core/src/main/java/org/apache/struts2/interceptor/httpmethod/HttpMethod.java
+++ b/core/src/main/java/org/apache/struts2/interceptor/httpmethod/HttpMethod.java
@@ -4,7 +4,7 @@ package org.apache.struts2.interceptor.httpmethod;
* Enum represents possible http request types
*
* @see HttpMethodInterceptor
- * @since 2.3.18
+ * @since 2.5
*/
public enum HttpMethod {
diff --git a/core/src/main/java/org/apache/struts2/interceptor/httpmethod/HttpMethodAware.java b/core/src/main/java/org/apache/struts2/interceptor/httpmethod/HttpMethodAware.java
index d6561f7ac..757ead20d 100644
--- a/core/src/main/java/org/apache/struts2/interceptor/httpmethod/HttpMethodAware.java
+++ b/core/src/main/java/org/apache/struts2/interceptor/httpmethod/HttpMethodAware.java
@@ -2,13 +2,13 @@ package org.apache.struts2.interceptor.httpmethod;
/**
* Action when implements this interface is notified about what method was used to perform request,
- * it works in connection with {@link org.apache.struts2.interceptor.httpmethod.HttpMethodInterceptor}
+ * it works in connection with {@link HttpMethodInterceptor}
*
* Another function of this interface is to return result which should be returned when action
* was called with wrong http method
*
* @see HttpMethodInterceptor
- * @since 2.3.18
+ * @since 2.5
*/
public interface HttpMethodAware {
@@ -22,7 +22,7 @@ public interface HttpMethodAware {
/**
* Action name to use when action was requested with wrong http method
* can return null and then default result name will be used instead defined
- * in {@link org.apache.struts2.interceptor.httpmethod.HttpMethodInterceptor}
+ * in {@link HttpMethodInterceptor}
*
* @return result name or null
*/
diff --git a/core/src/main/java/org/apache/struts2/interceptor/httpmethod/HttpMethodInterceptor.java b/core/src/main/java/org/apache/struts2/interceptor/httpmethod/HttpMethodInterceptor.java
index 300e203f2..ba2619315 100644
--- a/core/src/main/java/org/apache/struts2/interceptor/httpmethod/HttpMethodInterceptor.java
+++ b/core/src/main/java/org/apache/struts2/interceptor/httpmethod/HttpMethodInterceptor.java
@@ -23,16 +23,20 @@ import java.util.List;
* thus value will be used instead.
* <p/>
* To limit allowed http methods, annotate action class with {@link AllowedHttpMethod} and specify
- * which methods are allowed. You can also use shorter versions {@link HttpGet}, {@link HttpPost}
- * and {@link HttpGetOrPost}
+ * which methods are allowed. You can also use shorter versions {@link HttpGet}, {@link HttpPost},
+ * {@link HttpPut}, {@link HttpDelete} and {@link HttpGetOrPost}
+ *
+ * You can combine any of these annotations to achieve required allowed methods' filtering.
*
* @see HttpMethodAware
* @see HttpMethod
* @see AllowedHttpMethod
* @see HttpGet
* @see HttpPost
+ * @see HttpPut
+ * @see HttpDelete
* @see HttpGetOrPost
- * @since 2.3.18
+ * @since 2.5
*/
public class HttpMethodInterceptor extends AbstractInterceptor {
diff --git a/core/src/main/java/org/apache/struts2/interceptor/httpmethod/HttpPost.java b/core/src/main/java/org/apache/struts2/interceptor/httpmethod/HttpPost.java
index 7c9ff4a0e..8dcd9260d 100644
--- a/core/src/main/java/org/apache/struts2/interceptor/httpmethod/HttpPost.java
+++ b/core/src/main/java/org/apache/struts2/interceptor/httpmethod/HttpPost.java
@@ -9,7 +9,7 @@ import java.lang.annotation.Target;
* Use this annotation to allow call action or action's method via POST request only
*
* @see HttpMethodInterceptor
- * @since 2.3.18
+ * @since 2.5
*/
@Target({ElementType.METHOD, ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
diff --git a/core/src/main/java/org/apache/struts2/interceptor/httpmethod/HttpPut.java b/core/src/main/java/org/apache/struts2/interceptor/httpmethod/HttpPut.java
index 735b9e128..031217f0b 100644
--- a/core/src/main/java/org/apache/struts2/interceptor/httpmethod/HttpPut.java
+++ b/core/src/main/java/org/apache/struts2/interceptor/httpmethod/HttpPut.java
@@ -9,7 +9,7 @@ import java.lang.annotation.Target;
* Use this annotation to allow call action or action's method via PUT request only
*
* @see org.apache.struts2.interceptor.httpmethod.HttpMethodInterceptor
- * @since 2.3.18
+ * @since 2.5
*/
@Target({ElementType.METHOD, ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)