masonjm 2004/07/27 21:18:46
Modified: src/share/org/apache/slide/event RemoteInformation.java
Log:
Updates to the javadoc
Revision Changes Path
1.2 +26 -4
jakarta-slide/src/share/org/apache/slide/event/RemoteInformation.java
Index: RemoteInformation.java
===================================================================
RCS file:
/home/cvs/jakarta-slide/src/share/org/apache/slide/event/RemoteInformation.java,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- RemoteInformation.java 24 Feb 2004 16:47:07 -0000 1.1
+++ RemoteInformation.java 28 Jul 2004 04:18:46 -0000 1.2
@@ -24,10 +24,32 @@
package org.apache.slide.event;
/**
- * The RemoteInformation interface
+ * <p>The RemoteInformation interface.<p>
+ * <p>
+ * This is currently used by the webdav [EMAIL PROTECTED]
org.apache.slide.webdav.method.PollMethod PollMethod}
+ * to generate an XML representation of the data in an [EMAIL PROTECTED]
org.apache.slide.event event}.
+ * </p>
*
* @author <a href="mailto:[EMAIL PROTECTED]">Daniel Florey</a>
*/
public interface RemoteInformation {
+
+ /**
+ * The returned String[][] is assumed to be a String[?][2], where ? is
+ * greater than or equal to 0. The format of the returned value is
+ * assumed to be:
+ * <pre>
+ * {
+ * { "XML Element Name 1", "XML Element Value 1"},
+ * { "XML Element Name 2", "XML Element Value 2"},
+ * etc...
+ * }
+ * </pre>
+ * One noteable value for the element name is "uri". The Slide context path
+ * is preppended to the value of an element with this name before it is
+ * returned to the client.
+ *
+ * @return an array of name = value pairs.
+ */
public String[][] getInformation();
}
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
