Xj3D 2.0 VRML/X3D Code API

org.web3d.vrml.scripting
Interface ScriptEngine

All Known Implementing Classes:
ECMAScriptEngine, JavaSAIScriptEngine, JavascriptScriptEngine, VRML97ScriptEngine

public interface ScriptEngine

A representation of a class that is capable of being an interface to a scripting engine (eg javascript, java etc).

Version:
$Revision: 1.4 $
Author:
Justin Couch

Method Summary
 ScriptWrapper buildWrapper(VRMLExecutionSpace space, java.lang.String contentType, java.lang.Object content)
          Create a wrapper for the given script content.
 java.lang.String[] getSupportedContentTypes()
          Get a listing of the content types that this engine implementation can handle.
 int getSupportedSpecificationVersion()
          Get the version of the specification that this engine implementation supports.
 void setErrorReporter(ErrorReporter reporter)
          Register an error reporter with the engine so that any errors generated by the script code can be reported in a nice, pretty fashion.
 

Method Detail

getSupportedSpecificationVersion

int getSupportedSpecificationVersion()
Get the version of the specification that this engine implementation supports. A script engine only supports a single major version of any given spec.

Returns:
A number greater than one indicating the supported spec.

getSupportedContentTypes

java.lang.String[] getSupportedContentTypes()
Get a listing of the content types that this engine implementation can handle.

Returns:
A non-empty list of content types

buildWrapper

ScriptWrapper buildWrapper(VRMLExecutionSpace space,
                           java.lang.String contentType,
                           java.lang.Object content)
                           throws InvalidScriptContentException
Create a wrapper for the given script content. The wrapper will be built based on the details from the mime type.

Parameters:
space - The execution space this script belongs to
contentType - The MIME type of the engine
content - The actual content loaded from a stream
Returns:
An appropriate wrapper instance
Throws:
InvalidScriptContentException - The form of the content does not match the requirements of the engine.

setErrorReporter

void setErrorReporter(ErrorReporter reporter)
Register an error reporter with the engine so that any errors generated by the script code can be reported in a nice, pretty fashion. Setting a value of null will clear the currently set reporter. If one is already set, the new value replaces the old.

Parameters:
reporter - The instance to use or null

Xj3D 2.0 VRML/X3D Code API

Copyright © 2001 - 2006 Web3D Consortium