Revision: 10535
Author: bobv%google....@gtempaccount.com
Date: Tue Aug 16 13:53:38 2011
Log: Edited wiki page RequestFactoryInterfaceValidation through web
user interface.
http://code.google.com/p/google-web-toolkit/source/detail?r=10535
Modified:
/wiki/RequestFactoryInterfaceValidation.wiki
=======================================
--- /wiki/RequestFactoryInterfaceValidation.wiki Tue Aug 16 12:46:45 2011
+++ /wiki/RequestFactoryInterfaceValidation.wiki Tue Aug 16 13:53:38 2011
@@ -8,18 +8,18 @@
The RequestFactory annotation processor will validate the RequestFactory
interface declarations and ensure that the mapping of proxy properties and
context methods to their domain types is valid. The manner in which the
errors are reported depends on the method by which the annotation processor
is invoked.
-In addition to validating the interfaces, the annotation processor also
generates addition Java types which embed pre-computed metadata that is
required by the RequestFactory server components. Users of
`RequestFactorySource` must also run the annotation processor in order to
provide the client code with obfuscated type token mappings. In the
client-only case, the server domain types are not required.
+In addition to validating the interfaces, the annotation processor also
generates additional Java types which embed pre-computed metadata that is
required by the RequestFactory server components. Users of
`RequestFactorySource` must also run the annotation processor in order to
provide the client code with obfuscated type token mappings. In the
client-only case, the server domain types are not required.
If the validation process is not completed, a runtime error message will
be generated:
The RequestFactory ValidationTool must be run for the
com.example.shared.MyRequestFactory RequestFactory type
= Annotation Processor =
-It is necessary for both the shared RequestFactory interfaces and their
server domain counterparts to be available on the sourcepath or classpath
during the compilation process. If this is not convenient, see the
`ValidationTool` section for information on post-processing pre-compiled
shared interfaces and domain types as part of a deployment process.
+It most convenient for both the shared RequestFactory interfaces and their
server domain counterparts to be available on the sourcepath or classpath
during the compilation process. If this is not practical, see the
`ValidationTool` section for information on post-processing pre-compiled
shared interfaces and domain types as part of a deployment process.
== javac builds==
-Users using javac 1.6 or later to compile their server projects need only
to include the `requestfactory-apt.jar` on the build classpath. The
compiler will automatically load the annotation processor from the JAR file.
+Users using javac to compile their entire project at once need only to
include the `requestfactory-apt.jar` on the build classpath. The compiler
will automatically load the annotation processor from the JAR file. The
shared proxy interfaces must be included in the list of java files being
compiled.
== IDE configuration ==
@@ -51,4 +51,4 @@
com.example.shared.AnotherRequestFactory
}}}
-An optional client-only mode will produce the metadata required by
JVM-based RequestFactory clients using only the shared interfaces. This
mode is activated by adding a `-client` flag before the output location.
+An optional client-only mode will produce the metadata required by
`RequestFactorySource` clients using only the shared interfaces. This mode
is activated by adding a `-client` flag before the output location.
--
http://groups.google.com/group/Google-Web-Toolkit-Contributors
