org.netbeans.html.json.tck

Class KnockoutTCK

java.lang.Object

org.netbeans.html.json.tck.KnockoutTCK

public abstract class KnockoutTCK
extends Object

Entry point for providers of different HTML binding technologies (like Knockout.js in JavaFX's WebView). Sample usage:

@ServiceProvider(service = KnockoutTCK.class)
public final class MyKnockoutBindingTest extends KnockoutTCK {
    @Override
    protected BrwsrCtx createContext() {
        // use Contexts.Builder.build();
    }

     @org.testng.annotations.Factory
    public static Object[] create() {
        return VMTest.newTests().withClasses(KnockoutTCK.testClasses()()).build();
    }
}
 

Author:

Jaroslav Tulach

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	KnockoutTCK()

Method Summary

Modifier and Type	Method and Description
boolean	canFailWebSocketTest() Some implementations cannot fully support web sockets and fail.
abstract BrwsrCtx	createContext() Implement to create new context for the test.
abstract Object	createJSON(Map<String,Object> values) Create a JSON object as seen by the technology
abstract Object	executeScript(String script, Object[] arguments) Executes script in the context of current window
URI	prepareURL(String content, String mimeType, String[] parameters) Deprecated. provide KnockoutTCK.prepareWebResource(java.lang.String, java.lang.String, java.lang.String[]) implementation instead since post 1.4 version of HTML/Java API.
String	prepareWebResource(String content, String mimeType, String[] parameters) Creates a URL which later returns content with given mimeType and content.
boolean	scheduleLater(int delay, Runnable r) Schedules the given runnable to run later.
protected static Class<?>[]	testClasses() Gives you list of classes included in the TCK.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

KnockoutTCK

protected KnockoutTCK()

Method Detail

createContext

public abstract BrwsrCtx createContext()

Implement to create new context for the test. Use Contexts.Builder to set context for your technology up.

Returns:

the final context for the test

createJSON

public abstract Object createJSON(Map<String,Object> values)

Create a JSON object as seen by the technology

Parameters:

values - mapping from names to values of properties

Returns:

the JSON object with filled in values

executeScript

public abstract Object executeScript(String script,
                                     Object[] arguments)

Executes script in the context of current window

Parameters:

script - the JavaScript code to execute

arguments - arguments sent to the script (can be referenced as arguments[0])

Returns:

the output of the execution

prepareWebResource

public String prepareWebResource(String content,
                                 String mimeType,
                                 String[] parameters)

Creates a URL which later returns content with given mimeType and content. The content may be processed by the provided parameters.

Parameters:

content - what should be available on the URL. Can contain $0 $1 to reference parameters by their position

mimeType - the type of the resource

parameters - names of parameters as reference by content

Returns:

URL the test can connect to to obtain the (processed) content

Since:

1.5

prepareURL

@Deprecated
public URI prepareURL(String content,
                                  String mimeType,
                                  String[] parameters)

Deprecated. provide KnockoutTCK.prepareWebResource(java.lang.String, java.lang.String, java.lang.String[]) implementation instead since post 1.4 version of HTML/Java API.

testClasses

protected static Class<?>[] testClasses()

Gives you list of classes included in the TCK. Their test methods are annotated by KOTest annotation. The methods are public instance methods that take no arguments.

Returns:

classes with methods annotated by KOTest annotation

canFailWebSocketTest

public boolean canFailWebSocketTest()

Some implementations cannot fully support web sockets and fail.

Returns:

true, if UnsupportedOperationException reported from a web socket open operation is acceptable reply

scheduleLater

public boolean scheduleLater(int delay,
                             Runnable r)

Schedules the given runnable to run later.

Parameters:

delay - the delay in milliseconds

r - the runnable to run

Returns:

true if the runnable was really scheduled, false otherwise

Since:

1.5 version