Updates JavaDocs in annotations
Project: http://git-wip-us.apache.org/repos/asf/struts/repo Commit: http://git-wip-us.apache.org/repos/asf/struts/commit/f888e677 Tree: http://git-wip-us.apache.org/repos/asf/struts/tree/f888e677 Diff: http://git-wip-us.apache.org/repos/asf/struts/diff/f888e677 Branch: refs/heads/feature/http-interceptor Commit: f888e67751fceaac3a9fca8b991ddb4b4697d042 Parents: e798a9f Author: Lukasz Lenart <[email protected]> Authored: Sun Apr 20 22:13:58 2014 +0200 Committer: Lukasz Lenart <[email protected]> Committed: Sun Apr 20 22:13:58 2014 +0200 ---------------------------------------------------------------------- .../apache/struts2/interceptor/httpmethod/AllowedMethod.java | 6 ++++++ .../org/apache/struts2/interceptor/httpmethod/GetOnly.java | 6 ++++++ .../org/apache/struts2/interceptor/httpmethod/GetPostOnly.java | 6 ++++++ .../org/apache/struts2/interceptor/httpmethod/HttpMethod.java | 6 ++++++ .../apache/struts2/interceptor/httpmethod/HttpMethodAware.java | 1 + .../org/apache/struts2/interceptor/httpmethod/PostOnly.java | 6 ++++++ 6 files changed, 31 insertions(+) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/struts/blob/f888e677/core/src/main/java/org/apache/struts2/interceptor/httpmethod/AllowedMethod.java ---------------------------------------------------------------------- diff --git a/core/src/main/java/org/apache/struts2/interceptor/httpmethod/AllowedMethod.java b/core/src/main/java/org/apache/struts2/interceptor/httpmethod/AllowedMethod.java index 05d3795..435e60e 100644 --- a/core/src/main/java/org/apache/struts2/interceptor/httpmethod/AllowedMethod.java +++ b/core/src/main/java/org/apache/struts2/interceptor/httpmethod/AllowedMethod.java @@ -5,6 +5,12 @@ import java.lang.annotation.Retention; import java.lang.annotation.RetentionPolicy; 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 + */ @Target({ElementType.METHOD, ElementType.TYPE}) @Retention(RetentionPolicy.RUNTIME) public @interface AllowedMethod { http://git-wip-us.apache.org/repos/asf/struts/blob/f888e677/core/src/main/java/org/apache/struts2/interceptor/httpmethod/GetOnly.java ---------------------------------------------------------------------- diff --git a/core/src/main/java/org/apache/struts2/interceptor/httpmethod/GetOnly.java b/core/src/main/java/org/apache/struts2/interceptor/httpmethod/GetOnly.java index 2c782bd..6cf2dc6 100644 --- a/core/src/main/java/org/apache/struts2/interceptor/httpmethod/GetOnly.java +++ b/core/src/main/java/org/apache/struts2/interceptor/httpmethod/GetOnly.java @@ -5,6 +5,12 @@ import java.lang.annotation.Retention; import java.lang.annotation.RetentionPolicy; 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 + */ @Target({ElementType.METHOD, ElementType.TYPE}) @Retention(RetentionPolicy.RUNTIME) public @interface GetOnly { http://git-wip-us.apache.org/repos/asf/struts/blob/f888e677/core/src/main/java/org/apache/struts2/interceptor/httpmethod/GetPostOnly.java ---------------------------------------------------------------------- diff --git a/core/src/main/java/org/apache/struts2/interceptor/httpmethod/GetPostOnly.java b/core/src/main/java/org/apache/struts2/interceptor/httpmethod/GetPostOnly.java index 9f8df02..0668784 100644 --- a/core/src/main/java/org/apache/struts2/interceptor/httpmethod/GetPostOnly.java +++ b/core/src/main/java/org/apache/struts2/interceptor/httpmethod/GetPostOnly.java @@ -5,6 +5,12 @@ import java.lang.annotation.Retention; import java.lang.annotation.RetentionPolicy; 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 + */ @Target({ElementType.METHOD, ElementType.TYPE}) @Retention(RetentionPolicy.RUNTIME) public @interface GetPostOnly { http://git-wip-us.apache.org/repos/asf/struts/blob/f888e677/core/src/main/java/org/apache/struts2/interceptor/httpmethod/HttpMethod.java ---------------------------------------------------------------------- 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 30f4ea3..e1437f4 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 @@ -1,5 +1,11 @@ package org.apache.struts2.interceptor.httpmethod; +/** + * Enum represents possible http request types + * + * @see HttpMethodInterceptor + * @since 2.3.18 + */ public enum HttpMethod { GET, http://git-wip-us.apache.org/repos/asf/struts/blob/f888e677/core/src/main/java/org/apache/struts2/interceptor/httpmethod/HttpMethodAware.java ---------------------------------------------------------------------- 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 cfdc782..d6561f7 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 @@ -7,6 +7,7 @@ package org.apache.struts2.interceptor.httpmethod; * 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 */ public interface HttpMethodAware { http://git-wip-us.apache.org/repos/asf/struts/blob/f888e677/core/src/main/java/org/apache/struts2/interceptor/httpmethod/PostOnly.java ---------------------------------------------------------------------- diff --git a/core/src/main/java/org/apache/struts2/interceptor/httpmethod/PostOnly.java b/core/src/main/java/org/apache/struts2/interceptor/httpmethod/PostOnly.java index 1163188..0f3bcd5 100644 --- a/core/src/main/java/org/apache/struts2/interceptor/httpmethod/PostOnly.java +++ b/core/src/main/java/org/apache/struts2/interceptor/httpmethod/PostOnly.java @@ -5,6 +5,12 @@ import java.lang.annotation.Retention; import java.lang.annotation.RetentionPolicy; 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 + */ @Target({ElementType.METHOD, ElementType.TYPE}) @Retention(RetentionPolicy.RUNTIME) public @interface PostOnly {
