javadocs for CookiesAware

git-svn-id: https://svn.apache.org/repos/asf/struts/struts2/trunk@1463871 13f79535-47bb-0310-9956-ffa450edef68
rt-jar · Apr 3, 2013 · 2d02e2c · 2d02e2c
1 parent 4db60a8
commit 2d02e2c
Showing 1 changed file with 11 additions and 0 deletions.
diff --git a/core/src/main/java/org/apache/struts2/interceptor/CookiesAware.java b/core/src/main/java/org/apache/struts2/interceptor/CookiesAware.java
@@ -23,6 +23,17 @@
 
 import java.util.Map;
 
+/**
+ * Actions implementing the CookiesAware interface will receive
+ * a Map of filtered cookies via the setCookiesMap method.
+ *
+ * Please note that the {@link CookieInterceptor} needs to be
+ * activated to receive a cookies map.
+ */
 public interface CookiesAware {
+    /**
+     * Sets a map of filtered cookies.
+     * @param cookies the cookies
+     */
     void setCookiesMap(Map<String, String> cookies);
 }