svn commit: r758599 - in /jakarta/bsf/trunk/bsf3/bsf-api/src/main/java/javax/script: AbstractScriptEngine.java CompiledScript.java ScriptException.java SimpleBindings.java SimpleScriptContext.java

[se...@apache.org]

Author: sebb
Date: Thu Mar 26 11:25:25 2009
New Revision: 758599

URL: http://svn.apache.org/viewvc?rev=758599&view=rev
Log:
Add a bit more Javadoc relating to multi-threading

Modified:
    jakarta/bsf/trunk/bsf3/bsf-api/src/main/java/javax/script/AbstractScriptEngine.java
    jakarta/bsf/trunk/bsf3/bsf-api/src/main/java/javax/script/CompiledScript.java
    jakarta/bsf/trunk/bsf3/bsf-api/src/main/java/javax/script/ScriptException.java
    jakarta/bsf/trunk/bsf3/bsf-api/src/main/java/javax/script/SimpleBindings.java
    jakarta/bsf/trunk/bsf3/bsf-api/src/main/java/javax/script/SimpleScriptContext.java

Modified: jakarta/bsf/trunk/bsf3/bsf-api/src/main/java/javax/script/AbstractScriptEngine.java
URL: http://svn.apache.org/viewvc/jakarta/bsf/trunk/bsf3/bsf-api/src/main/java/javax/script/AbstractScriptEngine.java?rev=758599&r1=758598&r2=758599&view=diff
==============================================================================
--- jakarta/bsf/trunk/bsf3/bsf-api/src/main/java/javax/script/AbstractScriptEngine.java (original)
+++ jakarta/bsf/trunk/bsf3/bsf-api/src/main/java/javax/script/AbstractScriptEngine.java Thu Mar 26 11:25:25 2009
@@ -21,6 +21,13 @@
 import java.io.Reader;
 
 /**
+ * Provides a standard implementation for various versions of the eval() methods.
+ * Stores the ScriptContext, and provides access to the Bindings stored in the context.
+ * 
+ * The class is not synchronized.
+ * The default context - {@link SimpleScriptContext} - is not synchronized either. 
+ * Sub-classes must provide synchronization if necessary.
+ * 
  * See Javadoc of <a href="http://java.sun.com/javase/6/docs/api/javax/script/package-summary.html">Java Scripting API</a>
  */
 public abstract class AbstractScriptEngine implements ScriptEngine {

Modified: jakarta/bsf/trunk/bsf3/bsf-api/src/main/java/javax/script/CompiledScript.java
URL: http://svn.apache.org/viewvc/jakarta/bsf/trunk/bsf3/bsf-api/src/main/java/javax/script/CompiledScript.java?rev=758599&r1=758598&r2=758599&view=diff
==============================================================================
--- jakarta/bsf/trunk/bsf3/bsf-api/src/main/java/javax/script/CompiledScript.java (original)
+++ jakarta/bsf/trunk/bsf3/bsf-api/src/main/java/javax/script/CompiledScript.java Thu Mar 26 11:25:25 2009
@@ -18,6 +18,10 @@
 package javax.script;
 
 /**
+ * Base for classes that store the results of compilations.
+ * 
+ * This class is immutable.
+ * 
  * See Javadoc of <a href="http://java.sun.com/javase/6/docs/api/javax/script/package-summary.html">Java Scripting API</a>
  */
 public abstract class CompiledScript {

Modified: jakarta/bsf/trunk/bsf3/bsf-api/src/main/java/javax/script/ScriptException.java
URL: http://svn.apache.org/viewvc/jakarta/bsf/trunk/bsf3/bsf-api/src/main/java/javax/script/ScriptException.java?rev=758599&r1=758598&r2=758599&view=diff
==============================================================================
--- jakarta/bsf/trunk/bsf3/bsf-api/src/main/java/javax/script/ScriptException.java (original)
+++ jakarta/bsf/trunk/bsf3/bsf-api/src/main/java/javax/script/ScriptException.java Thu Mar 26 11:25:25 2009
@@ -20,9 +20,10 @@
 package javax.script;
 
 /**
+ * Generic Exception class for the Scripting APIs.
+ *
  * See Javadoc of <a href="http://java.sun.com/javase/6/docs/api/javax/script/package-summary.html">Java Scripting API</a>
  */
-//@Immutable
 public class ScriptException extends Exception {
 
     private static final long serialVersionUID = 2L;

Modified: jakarta/bsf/trunk/bsf3/bsf-api/src/main/java/javax/script/SimpleBindings.java
URL: http://svn.apache.org/viewvc/jakarta/bsf/trunk/bsf3/bsf-api/src/main/java/javax/script/SimpleBindings.java?rev=758599&r1=758598&r2=758599&view=diff
==============================================================================
--- jakarta/bsf/trunk/bsf3/bsf-api/src/main/java/javax/script/SimpleBindings.java (original)
+++ jakarta/bsf/trunk/bsf3/bsf-api/src/main/java/javax/script/SimpleBindings.java Thu Mar 26 11:25:25 2009
@@ -26,6 +26,9 @@
 import java.util.Set;
 
 /**
+ * A simple implementation of Bindings, backed by a HashMap (or other Map).
+ * This class is not synchronized (nor is HashMap).
+ * 
  * See Javadoc of <a href="http://java.sun.com/javase/6/docs/api/javax/script/package-summary.html">Java Scripting API</a>
  */
 public class SimpleBindings implements Bindings {

Modified: jakarta/bsf/trunk/bsf3/bsf-api/src/main/java/javax/script/SimpleScriptContext.java
URL: http://svn.apache.org/viewvc/jakarta/bsf/trunk/bsf3/bsf-api/src/main/java/javax/script/SimpleScriptContext.java?rev=758599&r1=758598&r2=758599&view=diff
==============================================================================
--- jakarta/bsf/trunk/bsf3/bsf-api/src/main/java/javax/script/SimpleScriptContext.java (original)
+++ jakarta/bsf/trunk/bsf3/bsf-api/src/main/java/javax/script/SimpleScriptContext.java Thu Mar 26 11:25:25 2009
@@ -28,6 +28,10 @@
 import java.util.List;
 
 /**
+ * A simple implementation of {@link ScriptContext}.
+ * 
+ * This class is not synchronized.
+ * 
  * See Javadoc of <a href="http://java.sun.com/javase/6/docs/api/javax/script/package-summary.html">Java Scripting API</a>
  */
 public class SimpleScriptContext implements ScriptContext {



---------------------------------------------------------------------
To unsubscribe, e-mail: bsf-dev-unsubscribe@jakarta.apache.org
For additional commands, e-mail: bsf-dev-help@jakarta.apache.org