Reviewers: rdayal,
Description:
Add javadocs for ExternalTextResource.getText
Repost of 1605803.
Thanks Stephen!
Fixes issue: 7035
Please review this at http://gwt-code-reviews.appspot.com/1733804/
Affected files:
M user/src/com/google/gwt/resources/client/ExternalTextResource.java
Index: user/src/com/google/gwt/resources/client/ExternalTextResource.java
===================================================================
--- user/src/com/google/gwt/resources/client/ExternalTextResource.java
(revision 11026)
+++ user/src/com/google/gwt/resources/client/ExternalTextResource.java
(working copy)
@@ -27,6 +27,16 @@
@DefaultExtensions(value = {".txt"})
@ResourceGeneratorType(ExternalTextResourceGenerator.class)
public interface ExternalTextResource extends ResourcePrototype {
- void getText(ResourceCallback<TextResource> callback)
- throws ResourceException;
+
+ /**
+ * Fetches a {@link TextResource} and calls {@code callback} with the
result.
+ *
+ * Caches after the first result, so {@code callback} is invoked
immediately for subsequent
+ * invocations.
+ *
+ * @throws ResourceException if the resource request cannot be
initiated, e.g. due to an invalid
+ * url or an AJAX security error (same origin violation)
+ */
+ void getText(ResourceCallback<TextResource> callback) throws
ResourceException;
+
}
--
http://groups.google.com/group/Google-Web-Toolkit-Contributors
