quintonm 2003/03/08 19:21:45
Modified: src/java/org/apache/turbine/util/parser
DefaultCookieParser.java
Log:
javadoc update
Revision Changes Path
1.10 +18 -6
jakarta-turbine-2/src/java/org/apache/turbine/util/parser/DefaultCookieParser.java
Index: DefaultCookieParser.java
===================================================================
RCS file:
/home/cvs/jakarta-turbine-2/src/java/org/apache/turbine/util/parser/DefaultCookieParser.java,v
retrieving revision 1.9
retrieving revision 1.10
diff -u -r1.9 -r1.10
--- DefaultCookieParser.java 9 Mar 2003 02:54:13 -0000 1.9
+++ DefaultCookieParser.java 9 Mar 2003 03:21:45 -0000 1.10
@@ -94,8 +94,8 @@
* @version $Id$
*/
public class DefaultCookieParser
- extends BaseValueParser
- implements CookieParser, Recyclable
+ extends BaseValueParser
+ implements CookieParser, Recyclable
{
/** Logging */
private static Log log = LogFactory.getLog(DefaultCookieParser.class);
@@ -136,7 +136,7 @@
* Gets the parsed RunData.
*
* @return the parsed RunData object or null.
- * @deprecated. Don't use the Run Data object. use getRequest().
+ * @deprecated Don't use the Run Data object. use getRequest().
*/
public RunData getRunData()
@@ -167,7 +167,6 @@
*
* @param data the RunData object.
*/
-
public void setRunData(RunData data)
{
setData(data.getRequest(), data.getResponse());
@@ -176,7 +175,7 @@
/**
* Sets Request and Response to be parsed.
- *
+ * <p>
* All previous cookies will be cleared.
*
* @param request The http request from the servlet
@@ -212,6 +211,8 @@
/**
* Get the Path where cookies will be stored
+ *
+ * @return path for cookie storage
*/
public DynamicURI getCookiePath()
{
@@ -220,6 +221,8 @@
/**
* Set the path for cookie storage
+ *
+ * @param path path for cookie storage
*/
public void setCookiePath(DynamicURI path)
{
@@ -229,6 +232,9 @@
/**
* Set a cookie that will be stored on the client for
* the duration of the session.
+ *
+ * @param name name of the cookie
+ * @param value value of the cookie
*/
public void set(String name, String value)
{
@@ -238,6 +244,10 @@
/**
* Set a persisten cookie on the client that will expire
* after a maximum age (given in seconds).
+ *
+ * @param name name of the cookie
+ * @param value value of the cookie
+ * @param seconds_age max age of the cookie in seconds
*/
public void set(String name, String value, int seconds_age)
{
@@ -254,6 +264,8 @@
/**
* Remove a previously set cookie from the client machine.
+ *
+ * @param name name of the cookie
*/
public void unset(String name)
{
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
