[Remoterengine-commits] r167 - in pkg/RemoteREngine/inst/java_src: . src/client/org/rosuda/REngine/remote/client src/client/org/rosuda/REngine/remote/client/callbacks src/common/org/rosuda/REngine/remote/common src/common/org/rosuda/REngine/remote/common/files src/common/org/rosuda/REngine/remote/common/tools src/server/org/rosuda/REngine/remote/server
noreply at r-forge.r-project.org
noreply at r-forge.r-project.org
Mon Sep 21 16:06:28 CEST 2009
Author: romain
Date: 2009-09-21 16:06:28 +0200 (Mon, 21 Sep 2009)
New Revision: 167
Modified:
pkg/RemoteREngine/inst/java_src/build.xml
pkg/RemoteREngine/inst/java_src/src/client/org/rosuda/REngine/remote/client/RemoteREngine.java
pkg/RemoteREngine/inst/java_src/src/client/org/rosuda/REngine/remote/client/callbacks/ClientCallbackDispatcher.java
pkg/RemoteREngine/inst/java_src/src/common/org/rosuda/REngine/remote/common/RemoteREngineInterface.java
pkg/RemoteREngine/inst/java_src/src/common/org/rosuda/REngine/remote/common/files/RemoteFileInputStream.java
pkg/RemoteREngine/inst/java_src/src/common/org/rosuda/REngine/remote/common/tools/ServiceManager.java
pkg/RemoteREngine/inst/java_src/src/common/org/rosuda/REngine/remote/common/tools/Waiter.java
pkg/RemoteREngine/inst/java_src/src/server/org/rosuda/REngine/remote/server/RemoteREngine_Server.java
pkg/RemoteREngine/inst/java_src/src/server/org/rosuda/REngine/remote/server/RemoteRMainLoopCallbacks.java
Log:
javadoc cleaning- no javadoc for annotation processor anymore
Modified: pkg/RemoteREngine/inst/java_src/build.xml
===================================================================
--- pkg/RemoteREngine/inst/java_src/build.xml 2009-09-21 12:46:06 UTC (rev 166)
+++ pkg/RemoteREngine/inst/java_src/build.xml 2009-09-21 14:06:28 UTC (rev 167)
@@ -90,7 +90,7 @@
windowtitle="Remote R Server Javadoc"
classpathref="server_classpath">
- <fileset dir="src" defaultexcludes="yes">
+ <fileset dir="src/common" defaultexcludes="yes">
<exclude name="**/*.xml"/>
<exclude name="**/*.properties"/>
<exclude name="**/*.html"/>
@@ -101,6 +101,30 @@
<exclude name="**/All*Tests.java"/>
</fileset>
+
+ <fileset dir="src/client" defaultexcludes="yes">
+ <exclude name="**/*.xml"/>
+ <exclude name="**/*.properties"/>
+ <exclude name="**/*.html"/>
+ <exclude name="**/*.htm"/>
+ <exclude name="**/test/*"/>
+ <exclude name="**/*Test.java"/>
+ <exclude name="**/All*Test.java"/>
+ <exclude name="**/All*Tests.java"/>
+ </fileset>
+
+ <fileset dir="src/server" defaultexcludes="yes">
+ <exclude name="**/*.xml"/>
+ <exclude name="**/*.properties"/>
+ <exclude name="**/*.html"/>
+ <exclude name="**/*.htm"/>
+ <exclude name="**/test/*"/>
+ <exclude name="**/*Test.java"/>
+ <exclude name="**/All*Test.java"/>
+ <exclude name="**/All*Tests.java"/>
+ </fileset>
+
+
<doctitle><![CDATA[<h1>Remote R Server Javadoc</h1>]]></doctitle>
<bottom><![CDATA[<i>Copyright © 2009, Romain Francois <a href="mailto://francoisromain@free.fr">francoisromain at free.fr</a></i>]]></bottom>
<link href="http://java.sun.com/j2se/1.5.0/docs/api/"/>
Modified: pkg/RemoteREngine/inst/java_src/src/client/org/rosuda/REngine/remote/client/RemoteREngine.java
===================================================================
--- pkg/RemoteREngine/inst/java_src/src/client/org/rosuda/REngine/remote/client/RemoteREngine.java 2009-09-21 12:46:06 UTC (rev 166)
+++ pkg/RemoteREngine/inst/java_src/src/client/org/rosuda/REngine/remote/client/RemoteREngine.java 2009-09-21 14:06:28 UTC (rev 167)
@@ -261,11 +261,10 @@
/**
* fetch the contents of the given reference.
* The resulting REXP may never be REXPReference.
- * The engine should raise a {@link #REngineException} exception
- * if {@link #supportsReferences()} returns <code>false</code>.
*
* @param ref reference to resolve
* @return resolved reference
+ * @throws REngineException if references are not supported
*/
public REXP resolveReference(REXP ref) throws REngineException, REXPMismatchException{
REXP res = null ;
@@ -278,8 +277,9 @@
}
/**
- * create a reference by pushing local data to R and returning a reference to the data. If ref is a reference it is returned as-is.
- * The engine should raise a {@link #REngineException} exception if {@link #supportsReferences()} returns <code>false</code>.
+ * create a reference by pushing local data to R and returning a reference to the data.
+ * If ref is a reference it is returned as-is.
+ * The engine should raise a <code>REngineException</code> exception if {@link #supportsReferences()} returns <code>false</code>.
*
* @param value to create reference to
* @return reference to the value
Modified: pkg/RemoteREngine/inst/java_src/src/client/org/rosuda/REngine/remote/client/callbacks/ClientCallbackDispatcher.java
===================================================================
--- pkg/RemoteREngine/inst/java_src/src/client/org/rosuda/REngine/remote/client/callbacks/ClientCallbackDispatcher.java 2009-09-21 12:46:06 UTC (rev 166)
+++ pkg/RemoteREngine/inst/java_src/src/client/org/rosuda/REngine/remote/client/callbacks/ClientCallbackDispatcher.java 2009-09-21 14:06:28 UTC (rev 167)
@@ -44,8 +44,7 @@
protected Vector<CallbackListener> listeners ;
/**
- * Constructor
- * @param client
+ * @param engine associated remote R engine
*/
public ClientCallbackDispatcher(RemoteREngine engine) {
super("client callback dispatcher");
Modified: pkg/RemoteREngine/inst/java_src/src/common/org/rosuda/REngine/remote/common/RemoteREngineInterface.java
===================================================================
--- pkg/RemoteREngine/inst/java_src/src/common/org/rosuda/REngine/remote/common/RemoteREngineInterface.java 2009-09-21 12:46:06 UTC (rev 166)
+++ pkg/RemoteREngine/inst/java_src/src/common/org/rosuda/REngine/remote/common/RemoteREngineInterface.java 2009-09-21 14:06:28 UTC (rev 167)
@@ -56,7 +56,7 @@
/**
* evaluate an expression vector
* @param what an expression (or vector of such) to evaluate
- * @param where environment to evaluate in (use <code>null</code> for the global environemnt and/or if environments are not supported by the engine)
+ * @param where environment to evaluate in (use <code>null</code> for the global environment and/or if environments are not supported by the engine)
* @param resolve resolve the resulting REXP or just return a reference
* @return the result of the evaluation of the last expression
*/
@@ -67,14 +67,14 @@
*
* @param symbol symbol name
* @param value value to assign
- * @param env environment to assign to (use <code>null</code> for the global environemnt and/or if environments are not supported by the engine
+ * @param env environment to assign to (use <code>null</code> for the global environment and/or if environments are not supported by the engine
*/
public void assign(String symbol, REXP value, REXP env) throws REngineException, REXPMismatchException, RemoteException;
/**
* get a value from an environment
* @param symbol symbol name
- * @param env environment (use <code>null</code> for the global environemnt and/or if environments are not supported by the engine)
+ * @param env environment (use <code>null</code> for the global environment and/or if environments are not supported by the engine)
* @param resolve resolve the resulting REXP or just return a reference
* @return value
*/
@@ -83,20 +83,19 @@
/**
* fetch the contents of the given reference.
* The resulting REXP may never be REXPReference.
- * The engine should raise a {@link #REngineException} exception
- * if {@link #supportsReferences()} returns <code>false</code>.
*
* @param ref reference to resolve
* @return resolved reference
+ * @throws REngineException if references are not supported
*/
public REXP resolveReference(REXP ref) throws REngineException, REXPMismatchException, RemoteException;
/**
* create a reference by pushing local data to R and returning a reference to the data. If ref is a reference it is returned as-is.
- * The engine should raise a {@link #REngineException} exception if {@link #supportsReferences()} returns <code>false</code>.
*
* @param value to create reference to
* @return reference to the value
+ * @throws REngineException if references are not supported by the engine
*/
public REXP createReference(REXP value) throws REngineException, REXPMismatchException, RemoteException;
Modified: pkg/RemoteREngine/inst/java_src/src/common/org/rosuda/REngine/remote/common/files/RemoteFileInputStream.java
===================================================================
--- pkg/RemoteREngine/inst/java_src/src/common/org/rosuda/REngine/remote/common/files/RemoteFileInputStream.java 2009-09-21 12:46:06 UTC (rev 166)
+++ pkg/RemoteREngine/inst/java_src/src/common/org/rosuda/REngine/remote/common/files/RemoteFileInputStream.java 2009-09-21 14:06:28 UTC (rev 167)
@@ -54,7 +54,7 @@
/**
* Tests if this input stream supports the mark and reset methods
*
- * @return
+ * @return true if this input stream supports the mark and reset methods
*/
public boolean markSupported() throws RemoteException ;
@@ -64,11 +64,10 @@
*/
public void reset() throws RemoteException, ServerSideIOException ;
- /**
- * Skips over and discards n bytes of data from this input stream.
- * @param n
- * @return
- * @throws ServerSideIOException when an IO exception happens on the server side
+ /**
+ * Skips over and discards n bytes of data from this input stream.
+ * @param n
+ * @throws ServerSideIOException when an IO exception happens on the server side
*/
public long skip(long n) throws RemoteException, ServerSideIOException ;
Modified: pkg/RemoteREngine/inst/java_src/src/common/org/rosuda/REngine/remote/common/tools/ServiceManager.java
===================================================================
--- pkg/RemoteREngine/inst/java_src/src/common/org/rosuda/REngine/remote/common/tools/ServiceManager.java 2009-09-21 12:46:06 UTC (rev 166)
+++ pkg/RemoteREngine/inst/java_src/src/common/org/rosuda/REngine/remote/common/tools/ServiceManager.java 2009-09-21 14:06:28 UTC (rev 167)
@@ -49,7 +49,7 @@
* @param <T> the type of {@link Service}
* @param serviceClass service class
* @param name name of the implementation of the service
- * @return
+ * @return an instance of the requested service
* @throws ServiceException
*/
@SuppressWarnings("unchecked")
Modified: pkg/RemoteREngine/inst/java_src/src/common/org/rosuda/REngine/remote/common/tools/Waiter.java
===================================================================
--- pkg/RemoteREngine/inst/java_src/src/common/org/rosuda/REngine/remote/common/tools/Waiter.java 2009-09-21 12:46:06 UTC (rev 166)
+++ pkg/RemoteREngine/inst/java_src/src/common/org/rosuda/REngine/remote/common/tools/Waiter.java 2009-09-21 14:06:28 UTC (rev 167)
@@ -41,6 +41,8 @@
*
* @param key the key
* @return the value of the given key
+ *
+ * FIXME: this is not correct as it blocks on the first asked key
*/
public synchronized V get(K key) {
while ( map.isEmpty() || !map.containsKey(key)){
@@ -53,8 +55,10 @@
}
/**
- * Adds an object to the queue
- * @param o object to add in the tail of the queue
+ * Adds an object to the map
+ *
+ * @param key key
+ * @param value value
*/
public synchronized void put(K key, V value) {
map.put(key, value);
Modified: pkg/RemoteREngine/inst/java_src/src/server/org/rosuda/REngine/remote/server/RemoteREngine_Server.java
===================================================================
--- pkg/RemoteREngine/inst/java_src/src/server/org/rosuda/REngine/remote/server/RemoteREngine_Server.java 2009-09-21 12:46:06 UTC (rev 166)
+++ pkg/RemoteREngine/inst/java_src/src/server/org/rosuda/REngine/remote/server/RemoteREngine_Server.java 2009-09-21 14:06:28 UTC (rev 167)
@@ -216,6 +216,15 @@
running = true;
}
+ /**
+ * utility to extract the long pointer from a reference. This is only used when making the variables
+ * object because it needs to transfer to the client before the client can resolve references
+ */
+ private long getPointer( REXPReference ref){
+ return ( (Long)ref.getHandle() ).longValue() ;
+ }
+
+
/**
* Constructor initializing R with the default arguments - service will run on a randomly assigned port
*
@@ -367,11 +376,10 @@
/**
* fetch the contents of the given reference.
* The resulting REXP may never be REXPReference.
- * The engine should raise a {@link #REngineException} exception
- * if {@link #supportsReferences()} returns <code>false</code>.
*
* @param ref reference to resolve
* @return resolved reference
+ * @throws REngineException when references are not supported
*/
public REXP resolveReference(REXP ref) throws REngineException, REXPMismatchException{
debug( ">> resolveReference" ) ;
@@ -379,11 +387,12 @@
}
/**
- * create a reference by pushing local data to R and returning a reference to the data. If ref is a reference it is returned as-is.
- * The engine should raise a {@link #REngineException} exception if {@link #supportsReferences()} returns <code>false</code>.
+ * create a reference by pushing local data to R and returning a reference to the data.
+ * If <code>value</code> is a reference it is returned as-is.
*
* @param value to create reference to
* @return reference to the value
+ * @throws REngineException if references are not supported
*/
public REXP createReference(REXP value) throws REngineException, REXPMismatchException{
debug( ">> createReference" ) ;
@@ -478,7 +487,7 @@
* Called when a client wants to send a command to the REPL
*
* @param cmd command to send to the REPL
- * @param client the client that sent the command
+ * @param origin the client that sent the command
*
* @throws RemoteException
*/
@@ -579,17 +588,11 @@
}
/**
- * The listeners associated with this server
- * @return
+ * @return The listeners associated with this server
*/
public synchronized Vector<CallbackListener> getCallbackListeners() {
return callbackListeners ;
}
-
- private long getPointer( REXPReference ref){
- return ( (Long)ref.getHandle() ).longValue() ;
- }
-
}
Modified: pkg/RemoteREngine/inst/java_src/src/server/org/rosuda/REngine/remote/server/RemoteRMainLoopCallbacks.java
===================================================================
--- pkg/RemoteREngine/inst/java_src/src/server/org/rosuda/REngine/remote/server/RemoteRMainLoopCallbacks.java 2009-09-21 12:46:06 UTC (rev 166)
+++ pkg/RemoteREngine/inst/java_src/src/server/org/rosuda/REngine/remote/server/RemoteRMainLoopCallbacks.java 2009-09-21 14:06:28 UTC (rev 167)
@@ -150,7 +150,7 @@
* called when R waits for user input. During the duration of this callback it
* is safe to re-enter R, and very often it is also the only time. The implementation
* is free to block on this call until the user hits Enter, but in JRI it is
- * a good idea to call {@link Rengine.rniIdle()} occasionally to allow other
+ * a good idea to call <code>Rengine.rniIdle()</code> occasionally to allow other
* event handlers (e.g graphics device UIs) to run. Implementations should NEVER return
* immediately even if there is no input - such behavior will result in a fast cycling event
* loop which makes the use of R pretty much impossible.
More information about the Remoterengine-commits
mailing list