Reviewers: rdayal,
Please review this at http://gwt-code-reviews.appspot.com/1605803/
Affected files:
M user/src/com/google/gwt/resources/client/ExternalTextResource.java
Index: user/src/com/google/gwt/resources/client/ExternalTextResource.java
diff --git
a/user/src/com/google/gwt/resources/client/ExternalTextResource.java
b/user/src/com/google/gwt/resources/client/ExternalTextResource.java
index
a1b0ba7539027dae01d0024e198774d9e1996b0a..ba12884f903a2a2991ab583d99e8d0ab9d333613
100644
--- a/user/src/com/google/gwt/resources/client/ExternalTextResource.java
+++ b/user/src/com/google/gwt/resources/client/ExternalTextResource.java
@@ -1,16 +1,14 @@
/*
* Copyright 2008 Google Inc.
*
- * Licensed under the Apache License, Version 2.0 (the "License"); you may
not
- * use this file except in compliance with the License. You may obtain a
copy of
- * the License at
+ * Licensed under the Apache License, Version 2.0 (the "License"); you may
not use this file except
+ * in compliance with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT
- * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
- * License for the specific language governing permissions and limitations
under
+ * Unless required by applicable law or agreed to in writing, software
distributed under the License
+ * is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF
ANY KIND, either express
+ * or implied. See the License for the specific language governing
permissions and limitations under
* the License.
*/
package com.google.gwt.resources.client;
@@ -20,13 +18,23 @@ import
com.google.gwt.resources.ext.ResourceGeneratorType;
import com.google.gwt.resources.rg.ExternalTextResourceGenerator;
/**
- * Identical to {@link TextResource}, except the contents of the resource
are
- * not inlined into the compiled output. This is suitable for resources
that are
- * not required as part of program initialization.
+ * Identical to {@link TextResource}, except the contents of the resource
are not inlined into the
+ * compiled output. This is suitable for resources that are not required
as part of program
+ * initialization.
*/
@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
