2 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
4 * Copyright 2013-2014 Oracle and/or its affiliates. All rights reserved.
6 * Oracle and Java are registered trademarks of Oracle and/or its affiliates.
7 * Other names may be trademarks of their respective owners.
9 * The contents of this file are subject to the terms of either the GNU
10 * General Public License Version 2 only ("GPL") or the Common
11 * Development and Distribution License("CDDL") (collectively, the
12 * "License"). You may not use this file except in compliance with the
13 * License. You can obtain a copy of the License at
14 * http://www.netbeans.org/cddl-gplv2.html
15 * or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the
16 * specific language governing permissions and limitations under the
17 * License. When distributing the software, include this License Header
18 * Notice in each file and include the License file at
19 * nbbuild/licenses/CDDL-GPL-2-CP. Oracle designates this
20 * particular file as subject to the "Classpath" exception as provided
21 * by Oracle in the GPL Version 2 section of the License file that
22 * accompanied this code. If applicable, add the following below the
23 * License Header, with the fields enclosed by brackets [] replaced by
24 * your own identifying information:
25 * "Portions Copyrighted [year] [name of copyright owner]"
29 * The Original Software is NetBeans. The Initial Developer of the Original
30 * Software is Oracle. Portions Copyright 2013-2014 Oracle. All Rights Reserved.
32 * If you wish your version of this file to be governed by only the CDDL
33 * or only the GPL Version 2, indicate your decision by adding
34 * "[Contributor] elects to include this software in this distribution
35 * under the [CDDL or GPL Version 2] license." If you do not indicate a
36 * single choice of license, a recipient has the option to distribute
37 * your version of this file under either the CDDL, the GPL Version 2 or
38 * to extend the choice of license to its licensees as provided above.
39 * However, if you add GPL Version 2 code and therefore, elected the GPL
40 * Version 2 license, then the option applies only if the new code is
41 * made subject to such option by the copyright holder.
43 package net.java.html.js;
45 import java.lang.annotation.ElementType;
46 import java.lang.annotation.Retention;
47 import java.lang.annotation.RetentionPolicy;
48 import java.lang.annotation.Target;
50 /** Put this annotation on a method to provide its special implementation
51 * in JavaScript. This is a way to define <em>native</em> methods that
52 * interact with the surrounding JavaScript environment. Check the list
53 * <a href="package-summary.html">use-cases</a> to see real world
54 * use of this annotation.
56 * Visit an <a target="_blank" href="http://dew.apidesign.org/dew/#7102188">on-line demo</a>
57 * to play with {@link JavaScriptBody} annotation for real.
59 * @author Jaroslav Tulach
61 @Retention(RetentionPolicy.CLASS)
62 @Target({ ElementType.METHOD, ElementType.CONSTRUCTOR })
63 public @interface JavaScriptBody {
64 /** Names of parameters for the method generated method that can
65 * be referenced from {@link #body()}.
67 * @return array of the names of parameters for the method
70 public String[] args();
72 /** The actual body of the method in JavaScript. This string will be
73 * put into generated header (last character is '{') and footer (e.g. '}').
74 * The body can reference provided arguments. In case of non-static
75 * instance method it may reference <code>this</code>.
77 * @return JavaScript body of a function which can access {@link #args()} and possibly
82 /** Should a special syntax for calling back into Java object be turned on?
83 * The syntax begins with <b>{@code @}</b> followed by fully qualified
84 * package name of the class. Now followed by <b>::</b> and a method in
85 * the class followed by its parameters enclosed inside <b>(...)</b>.
86 * This is the syntax one can use to call <code>run()</code>
87 * method of {@link Runnable}:
88 * <pre>r.@java.lang.Runnable::run()()</pre>.
89 * One can also call static methods. Just use:
90 * <pre>var ten = @java.lang.Integer::parseInt(Ljava/lang/String;)("10")</pre>
92 * @return true, if the script should be scanned for special callback
95 public boolean javacall() default false;
97 /** Should we wait before the JavaScript snippet execution finishes?
100 * Some implementations that recognize the {@link JavaScriptBody} annotation
101 * need to reschedule the JavaScript execution into different thread and
102 * then it is easier for them to perform the execution asynchronously
103 * and not wait for the result of the execution. This may however be
104 * unexpected (for example when one awaits a callback into Java)
105 * and as such it has to be explicitly allowed by specifying
106 * <code>wait4js = false</code>. Such methods need to return <code>void</code>.
108 * Implementations that execute the JavaScript synchronously may ignore
111 * Implementations that delay execution of JavaScript need to guarantee
112 * the order of snippets. Those that were submitted sooner, need to be
113 * executed sooner. Each snippet need to be executed in a timely manner
114 * (e.g. by a second, or so) even if there are no other calls made
115 * in the main program.
119 * @return <code>false</code> in case one allows asynchronous execution
120 * of the JavaScript snippet
122 public boolean wait4js() default true;