boot-script/src/main/java/net/java/html/boot/script/Scripts.java
author Jaroslav Tulach <jtulach@netbeans.org>
Thu, 05 Jun 2014 21:01:56 +0200
branchenvjs
changeset 700 055a0f3766f5
parent 699 82773e03ff40
child 716 0654466b2273
permissions -rw-r--r--
A bit of documentation
     1 /**
     2  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
     3  *
     4  * Copyright 2013-2014 Oracle and/or its affiliates. All rights reserved.
     5  *
     6  * Oracle and Java are registered trademarks of Oracle and/or its affiliates.
     7  * Other names may be trademarks of their respective owners.
     8  *
     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]"
    26  *
    27  * Contributor(s):
    28  *
    29  * The Original Software is NetBeans. The Initial Developer of the Original
    30  * Software is Oracle. Portions Copyright 2013-2014 Oracle. All Rights Reserved.
    31  *
    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.
    42  */
    43 package net.java.html.boot.script;
    44 
    45 import java.util.concurrent.Executor;
    46 import javax.script.ScriptEngine;
    47 import net.java.html.boot.BrowserBuilder;
    48 import net.java.html.js.JavaScriptBody;
    49 import org.apidesign.html.boot.spi.Fn.Presenter;
    50 
    51 /** Implementations of {@link Presenter}s that delegate
    52  * to Java {@link ScriptEngine scripting} API. Initialize your presenter
    53  * like this:
    54  * 
    55  * <pre>
    56  * 
    57  * {@link Runnable} <em>run</em> = ...; // your own init code
    58  * {@link Presenter Fn.Presenter} <em>p</em> = Scripts.{@link Scripts#createPresenter()};
    59  * BrowserBuilder.{@link BrowserBuilder#newBrowser(java.lang.Object...) newBrowser(<em>p</em>)}.
    60  *      {@link BrowserBuilder#loadFinished(java.lang.Runnable) loadFinished(run)}.
    61  *      {@link BrowserBuilder#showAndWait()};
    62  * </pre>
    63  * 
    64  * and your runnable can make extensive use of {@link JavaScriptBody} directly or
    65  * indirectly via APIs using {@link JavaScriptBody such annotation} themselves.
    66  * 
    67  * @author Jaroslav Tulach
    68  */
    69 public final class Scripts {
    70     private Scripts() {
    71     }
    72     
    73     /** Simple implementation of {@link Presenter} that delegates
    74      * to Java {@link ScriptEngine scripting} API. The presenter runs headless
    75      * without appropriate simulation of browser APIs. Its primary usefulness
    76      * is inside testing environments. The presenter implements {@link Executor}
    77      * interface, but invokes all runnables passed to {@link Executor#execute(java.lang.Runnable)}
    78      * immediately.
    79      * 
    80      * @return new instance of a presenter that is using its own
    81      *   {@link ScriptEngine} for <code>text/javascript</code> mimetype
    82      */
    83     public static Presenter createPresenter() {
    84         return new ScriptPresenter(null);
    85     }
    86 
    87     /** Implementation of {@link Presenter} that delegates
    88      * to Java {@link ScriptEngine scripting} API and can control execution
    89      * thread. The presenter runs headless
    90      * without appropriate simulation of browser APIs. Its primary usefulness
    91      * is inside testing environments. The presenter implements {@link Executor}
    92      * interface, and passes all runnables from {@link Executor#execute(java.lang.Runnable)}
    93      * to here in provided <code>exc</code> instance.
    94      * 
    95      * @param exc the executor to re-schedule all asynchronous requests to
    96      * @return new instance of a presenter that is using its own
    97      *   {@link ScriptEngine} for <code>text/javascript</code> mimetype
    98      */
    99     public static Presenter createPresenter(Executor exc) {
   100         return new ScriptPresenter(exc);
   101     }
   102 }