During the API review process (bug 246133) the reviewers decided that in order to include html4j to NetBeans Platform, we need to stop using org.apidesign namespace and switch to NetBeans one. Repackaging all SPI packages into org.netbeans.html.smthng.spi.
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 org.netbeans.html.json.tck;
47 import net.java.html.BrwsrCtx;
48 import net.java.html.json.tests.ConvertTypesTest;
49 import net.java.html.json.tests.JSONTest;
50 import net.java.html.json.tests.KnockoutTest;
51 import net.java.html.json.tests.MinesTest;
52 import net.java.html.json.tests.OperationsTest;
53 import net.java.html.json.tests.Utils;
54 import net.java.html.json.tests.WebSocketTest;
55 import org.netbeans.html.context.spi.Contexts.Builder;
56 import org.openide.util.lookup.ServiceProvider;
58 /** Entry point for providers of different HTML binding technologies (like
59 * Knockout.js in JavaFX's WebView). Sample usage:
62 {@link ServiceProvider @ServiceProvider}(service = KnockoutTCK.class)
63 public final class MyKnockoutBindingTest extends KnockoutTCK {
64 {@link Override @Override}
65 protected BrwsrCtx createContext() {
66 // use {@link Builder}.{@link Builder#build() build}();
69 {@code @}{@link org.testng.annotations.Factory} public static Object[] create() {
70 return VMTest.newTests().withClasses({@link KnockoutTCK#testClasses}()).build();
75 * @author Jaroslav Tulach
77 public abstract class KnockoutTCK {
78 protected KnockoutTCK() {
79 Utils.registerTCK(this);
82 /** Implement to create new context for the test.
83 * Use {@link Builder} to set context for your technology up.
84 * @return the final context for the test
86 public abstract BrwsrCtx createContext();
88 /** Create a JSON object as seen by the technology
89 * @param values mapping from names to values of properties
90 * @return the JSON object with filled in values
92 public abstract Object createJSON(Map<String,Object> values);
94 /** Executes script in the context of current window
96 * @param script the JavaScript code to execute
97 * @param arguments arguments sent to the script (can be referenced as <code>arguments[0]</code>)
98 * @return the output of the execution
100 public abstract Object executeScript(String script, Object[] arguments);
102 /** Creates a URL which later returns content with given
103 * <code>mimeType</code> and <code>content</code>. The
104 * content may be processed by the provided <code>parameters</code>.
106 * @param content what should be available on the URL. Can contain <code>$0</code>
107 * <code>$1</code> to reference <code>parameters</code> by their position
108 * @param mimeType the type of the resource
109 * @param parameters names of parameters as reference by <code>content</code>
110 * @return URI the test can connect to to obtain the (processed) content
112 public abstract URI prepareURL(String content, String mimeType, String[] parameters);
114 /** Gives you list of classes included in the TCK. Their test methods
115 * are annotated by {@link KOTest} annotation. The methods are public
116 * instance methods that take no arguments.
118 * @return classes with methods annotated by {@link KOTest} annotation
120 protected static Class<?>[] testClasses() {
122 ConvertTypesTest.class,
126 OperationsTest.class,
131 /** Some implementations cannot fully support web sockets and fail.
133 * @return true, if UnsupportedOperationException reported from a web
134 * socket open operation is acceptable reply
136 public boolean canFailWebSocketTest() {