package votorola.a.web.gwt; // Copyright 2012, Michael Allan.  Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Votorola Software"), to deal in the Votorola Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicence, and/or sell copies of the Votorola Software, and to permit persons to whom the Votorola Software is furnished to do so, subject to the following conditions: The preceding copyright notice and this permission notice shall be included in all copies or substantial portions of the Votorola Software. THE VOTOROLA SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE VOTOROLA SOFTWARE OR THE USE OR OTHER DEALINGS IN THE VOTOROLA SOFTWARE.

import java.lang.annotation.*;


/** Marks a callback method for purposes of GWT configuration.  See the complete <a
  * href='../../../../votorola/a/web/gwt/class-use/GWTConfigCallback.html'>list of
  * configuration callbacks</a> and the usage instructions for each.  Each is callback
  * method exposed as a global JavaScript function for callback from the configuration
  * script <code>gwt.js</code> (a), which may optionally be placed in the vote-server's
  * <code>publicConfig</code> directory.  An empty template (b) of <code>gwt.js</code> is
  * provided for reference, along with a working example (c) from the development
  * vote-server.  Unlike an {@linkplain GWTInitCallback initialization callback}, a
  * configuration callback is invoked immediately on {@linkplain
  * EntryPointS#onModuleLoad() module load}.
  *
  * <ol type='a'>
  *     <li>/home/<a href='../../../../../../s/manual.xht#vote-server-file' target='_top'>VOTE-SERVER</a>/votorola/web/publicConfig/gwt.js</li>
  *     <li><a href='../../../../../../a/web/gwt/gwt.js' target='_top'>votorola/a/web/gwt/gwt.js</a></li>
  *     <li><a href='../../../../../../s/_/example/full/home/vdev/votorola/web/publicConfig/gwt.js' target='_top'>votorola/s/_/example/full/home/vdev/votorola/web/publicConfig/gwt.js</a></li>
  *     </ol>
  */
  @Documented @Retention(RetentionPolicy.SOURCE) @Target(ElementType.METHOD)
public @interface GWTConfigCallback {}


  // Although each callback method is accessible to native "handwritten" script [1], and
  // although the method could return a compiled Java object (non-JavaScriptObject), there
  // would be no way for the script to access its members.  The JSNI naming and access
  // mechanism [2] works only for JavaScript *within* GWT compiled native methods.
  //
  // The callback methods are wrapped in $entry and must therefore be static, per grep
  // ENTRY_MACRO.
  //
  // [1] http://code.google.com/webtoolkit/doc/latest/DevGuideCodingBasicsJSNI.html#calling
  // [2] http://code.google.com/webtoolkit/doc/latest/DevGuideCodingBasicsJSNI.html#methods-fields