Revision: 15885
http://gate.svn.sourceforge.net/gate/?rev=15885&view=rev
Author: ian_roberts
Date: 2012-06-12 12:00:41 +0000 (Tue, 12 Jun 2012)
Log Message:
-----------
Improved toXml JavaDoc to point out that in many cases it's better to use
DocumentStaxUtils directly rather than calling toXml.
Modified Paths:
--------------
gate/trunk/src/gate/Document.java
Modified: gate/trunk/src/gate/Document.java
===================================================================
--- gate/trunk/src/gate/Document.java 2012-06-12 01:28:47 UTC (rev 15884)
+++ gate/trunk/src/gate/Document.java 2012-06-12 12:00:41 UTC (rev 15885)
@@ -20,6 +20,7 @@
import java.util.Map;
import java.util.Set;
+import gate.corpora.DocumentStaxUtils;
import gate.event.DocumentListener;
import gate.util.InvalidOffsetException;
@@ -130,7 +131,14 @@
public Boolean getCollectRepositioningInfo();
/** Returns a GateXml document. This document is actually a serialization of
- * a Gate Document in XML.
+ * a Gate Document in XML. The <code>writeDocument</code> methods of
+ * {@link DocumentStaxUtils} provide the standard implementation of this
+ * serialization format which will work for any Document implementation.
+ * Implementations of <code>toXml</code> will typically delegate to
+ * <code>DocumentStaxUtils</code>, and in many cases it will be more
+ * efficient for callers to use that directly rather than calling
+ * <code>toXml</code>.
+ * @see DocumentStaxUtils
* @return a string representing a Gate Xml document
*/
public String toXml();
This was sent by the SourceForge.net collaborative development platform, the
world's largest Open Source development site.
------------------------------------------------------------------------------
Live Security Virtual Conference
Exclusive live event will cover all the ways today's security and
threat landscape has changed and how IT managers can respond. Discussions
will include endpoint security, mobile security and the latest in malware
threats. http://www.accelacomm.com/jaw/sfrnl04242012/114/50122263/
_______________________________________________
GATE-cvs mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/gate-cvs
