jefft 02/01/12 22:19:00
Modified: latka/src/java/org/apache/commons/latka/event
BaseRequestEvent.java
Log:
Some javadocs
Submitted by: Dion Gillard <dion at multitask.com.au>
Revision Changes Path
1.5 +52 -21
jakarta-commons/latka/src/java/org/apache/commons/latka/event/BaseRequestEvent.java
Index: BaseRequestEvent.java
===================================================================
RCS file:
/home/cvs/jakarta-commons/latka/src/java/org/apache/commons/latka/event/BaseRequestEvent.java,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- BaseRequestEvent.java 23 Aug 2001 16:24:25 -0000 1.4
+++ BaseRequestEvent.java 13 Jan 2002 06:19:00 -0000 1.5
@@ -63,26 +63,57 @@
import org.apache.commons.latka.http.Response;
import org.apache.commons.latka.http.Session;
+/**
+ * The base class for request events fired by latka.
+ * It provides the request, response and session for use by
+ * clients
+ * @author
+ * @version $Id: BaseRequestEvent.java,v 1.5 2002/01/13 06:19:00 jefft Exp $
+ */
public class BaseRequestEvent implements RequestEvent {
- public BaseRequestEvent(Request request, Response response) {
- _session = request.getSession();
- _request = request;
- _response = response;
- }
-
- public Request getRequest() {
- return _request;
- }
-
- public Response getResponse() {
- return _response;
- }
-
- public Session getSession() {
- return _session;
- }
-
- private Request _request = null;
- private Response _response = null;
- private Session _session = null;
+
+ /**
+ * the request the event relates to
+ */
+ private Request _request = null;
+
+ /**
+ * the response the event relates to
+ */
+ private Response _response = null;
+
+ /**
+ * the session of the request for the event
+ */
+ private Session _session = null;
+
+ /**
+ * Store the request, response and session for later retrieval
+ */
+ public BaseRequestEvent(Request request, Response response) {
+ _session = request.getSession();
+ _request = request;
+ _response = response;
+ }
+
+ /**
+ * @return the request the event relates to
+ */
+ public Request getRequest() {
+ return _request;
+ }
+
+ /**
+ * @return the response the event relates to
+ */
+ public Response getResponse() {
+ return _response;
+ }
+
+ /**
+ * @return the session the event relates to
+ */
+ public Session getSession() {
+ return _session;
+ }
}
--
To unsubscribe, e-mail: <mailto:[EMAIL PROTECTED]>
For additional commands, e-mail: <mailto:[EMAIL PROTECTED]>
