diff --git a/build.gradle b/build.gradle index 90b5889..a7085e3 100644 --- a/build.gradle +++ b/build.gradle @@ -22,7 +22,7 @@ dependencies { jar { baseName = 'jDeployR' - version = '8.0.1' + version = '8.0.5' } javadoc { diff --git a/examples/tutorial/build.gradle b/examples/tutorial/build.gradle index 6c84a75..404d454 100644 --- a/examples/tutorial/build.gradle +++ b/examples/tutorial/build.gradle @@ -28,7 +28,7 @@ dependencies { jar { baseName = 'client-tutorial' - version = '8.0.1' + version = '8.0.5' } task execute(type: JavaExec) { diff --git a/src/main/java/com/revo/deployr/client/RClient.java b/src/main/java/com/revo/deployr/client/RClient.java index 9141375..e8a4006 100644 --- a/src/main/java/com/revo/deployr/client/RClient.java +++ b/src/main/java/com/revo/deployr/client/RClient.java @@ -60,7 +60,7 @@ public RUser login(RAuthentication pAuthentication, boolean disableautosave) /** * Execute a single repository-managed script or a chain of * repository-managed scripts on an anonymous project. - *

+ *

* To execute a chain of repository-managed scripts on this call provide a comma-separated * list of values on the scriptName, scriptAuthor and optionally scriptVersion parameters. * Chained execution executes each of the scripts identified on the call in a sequential @@ -86,7 +86,7 @@ public RScriptExecution executeScript(String scriptName, /** * Execute a single repository-managed script or a chain of * repository-managed scripts on an anonymous project. - *

+ *

* To execute a chain of repository-managed scripts on this call provide a comma-separated * list of values on the scriptName, scriptAuthor and optionally scriptVersion parameters. * Chained execution executes each of the scripts identified on the call in a sequential @@ -112,7 +112,7 @@ public RScriptExecution executeScript(String scriptName, /** * Execute a single repository-managed script or a chain of repository-managed scripts * on an anonymous project. - *

+ *

* To execute a chain of repository-managed scripts on this call provide a comma-separated * list of values on the scriptName, scriptAuthor and optionally scriptVersion parameters. * Chained execution executes each of the scripts identified on the call in a sequential @@ -134,7 +134,7 @@ public RScriptExecution executeScript(String scriptName, /** * Execute a single repository-managed script or a chain of repository-managed scripts * on an anonymous project. - *

+ *

* To execute a chain of repository-managed scripts on this call provide a comma-separated * list of values on the scriptName, scriptAuthor and optionally scriptVersion parameters. * Chained execution executes each of the scripts identified on the call in a sequential @@ -157,12 +157,12 @@ public RScriptExecution executeScript(String scriptName, /** * Execute a single script found on a URL/path or a chain of scripts found on a set of URLs/paths * on an anonymous project. - *

+ *

* To execute a chain of repository-managed scripts on this call provide a comma-separated * list of values on the externalSource parameter. * Chained execution executes each of the scripts identified on the call in a sequential * fashion on the R session, with execution occuring in the order specified on the parameter list. - *

+ *

* POWER_USER privileges are required for this call. * * @throws RClientException if RClient fails to complete call. @@ -179,14 +179,14 @@ public RScriptExecution executeExternal(String externalSource, /** * Execute a single repository-managed script or a chain of repository-managed scripts * on an anonymous project and render the outputs to a HTML page. - *

+ *

* To execute a chain of repository-managed scripts on this call provide a comma-separated * list of values on the scriptName, scriptAuthor and optionally scriptVersion parameters. * Chained execution executes each of the scripts identified on the call in a sequential * fashion on the R session, with execution occuring in the order specified on the parameter list. * * @throws RClientException if RClient fails to complete call. - * @throws RSecurityException if DeployR server security conditions not met on call. + * @throws RDataException if DeployR server security conditions not met on call. * @see RScriptExecution */ public URL renderScript(String scriptName, diff --git a/src/main/java/com/revo/deployr/client/RProject.java b/src/main/java/com/revo/deployr/client/RProject.java index 5a12c65..0ebb8fb 100644 --- a/src/main/java/com/revo/deployr/client/RProject.java +++ b/src/main/java/com/revo/deployr/client/RProject.java @@ -113,10 +113,10 @@ public interface RProject extends /** * Recycle R session on project. - *

+ *

* Recycles the R session associated with the project by deleting all * R objects from the workspace and all files from the working directory. - *

+ *

* Recommended for temporary and blackbox projects. Recycle persistent projects * with caution as this operation can not be reversed. * @@ -130,16 +130,16 @@ public RProjectDetails recycle() /** * Recycle R session on project. - *

+ *

* Recycles the R session associated with the project by deleting all * R objects from the workspace and all files from the working directory. - *

+ *

* Workspace objects and/or directory files can be preserved on a recycle * by enabling the respective parameter. - *

+ *

* Recycling a project is a convenient and efficient alternative to * starting over by closing an existing project and then creating a new project. - *

+ *

* Recommended for temporary and blackbox projects. Recycle persistent projects * with caution as this operation can not be reversed. * diff --git a/src/main/java/com/revo/deployr/client/RRepositoryDirectory.java b/src/main/java/com/revo/deployr/client/RRepositoryDirectory.java index b61d57b..6d3556e 100644 --- a/src/main/java/com/revo/deployr/client/RRepositoryDirectory.java +++ b/src/main/java/com/revo/deployr/client/RRepositoryDirectory.java @@ -38,7 +38,7 @@ public interface RRepositoryDirectory { /** * Update access-controls on files found in repository-managed user directory. - *

+ *

* If the files parameter is null, all files in the directory are updated. * * @throws RClientException if RClient fails to complete call. @@ -79,7 +79,7 @@ public RRepositoryDirectory rename(String newDirectoryName) /** * Download zip archive of files found in repository-managed user directory. - *

+ *

* If the files parameter is null, all files in the directory are downloaded. * * @throws RClientException if RClient fails to complete call. diff --git a/src/main/java/com/revo/deployr/client/about/RJobDetails.java b/src/main/java/com/revo/deployr/client/about/RJobDetails.java index d30ede7..3dc8b35 100644 --- a/src/main/java/com/revo/deployr/client/about/RJobDetails.java +++ b/src/main/java/com/revo/deployr/client/about/RJobDetails.java @@ -94,7 +94,7 @@ public RJobDetails(String id, String name, String descr, String status, String s /** * Code execution time (millis) for job. Measures the time taken to * execute the R code for the job. - *

+ *

* Can be used in conjunction with timeStart and timeTotal to profile * job runtime characteristics. */ @@ -104,7 +104,7 @@ public RJobDetails(String id, String name, String descr, String status, String s * Total time (millis) for job. Measures the time taken to prepare * R workspace and directory for job, execute code for the job and then * persist job artifacts as a persistent project. - *

+ *

* Can be used in conjunction with timeStart and timeCode to profile * job runtime characteristics. */ diff --git a/src/main/java/com/revo/deployr/client/about/RProjectExecutionDetails.java b/src/main/java/com/revo/deployr/client/about/RProjectExecutionDetails.java index 76289d8..067880d 100644 --- a/src/main/java/com/revo/deployr/client/about/RProjectExecutionDetails.java +++ b/src/main/java/com/revo/deployr/client/about/RProjectExecutionDetails.java @@ -62,7 +62,7 @@ public RProjectExecutionDetails(String id, String code, long timeStart, long tim /** * Code execution time (millis) for execution. Measures the time taken to * execute the R code for execution. - *

+ *

* Can be used in conjunction with timeStart and timeTotal to profile * execution runtime characteristics. */ @@ -72,7 +72,7 @@ public RProjectExecutionDetails(String id, String code, long timeStart, long tim * Total time (millis) for execution. Measures the time taken to prepare * R workspace and directory for execution, execute R code and then * persist execution artifacts to on project. - *

+ *

* Can be used in conjunction with timeStart and timeCode to profile * execution runtime characteristics. */ diff --git a/src/main/java/com/revo/deployr/client/api/RProjectExecuteCalls.java b/src/main/java/com/revo/deployr/client/api/RProjectExecuteCalls.java index 496013d..c232868 100644 --- a/src/main/java/com/revo/deployr/client/api/RProjectExecuteCalls.java +++ b/src/main/java/com/revo/deployr/client/api/RProjectExecuteCalls.java @@ -51,7 +51,7 @@ public RProjectExecution executeCode(String code, /** * Execute a single repository-managed script or a chain of * repository-managed scripts on the current project. - *

+ *

* To execute a chain of repository-managed scripts on this call provide a comma-separated * list of values on the scriptName, scriptAuthor and optionally scriptVersion parameters. * Chained execution executes each of the scripts identified on the call in a sequential @@ -74,7 +74,7 @@ public RProjectExecution executeScript(String scriptName, /** * Execute a single repository-managed script or a chain of * repository-managed scripts on the current project. - *

+ *

* To execute a chain of repository-managed scripts on this call provide a comma-separated * list of values on the scriptName, scriptAuthor and optionally scriptVersion parameters. * Chained execution executes each of the scripts identified on the call in a sequential @@ -99,7 +99,7 @@ public RProjectExecution executeScript(String scriptName, /** * Execute a single repository-managed script or a chain of repository-managed scripts * on the current project. - *

+ *

* To execute a chain of repository-managed scripts on this call provide a comma-separated * list of values on the scriptName, scriptAuthor and optionally scriptVersion parameters. * Chained execution executes each of the scripts identified on the call in a sequential @@ -120,7 +120,7 @@ public RProjectExecution executeScript(String scriptName, /** * Execute a single repository-managed script or a chain of repository-managed scripts * on the current project. - *

+ *

* To execute a chain of repository-managed scripts on this call provide a comma-separated * list of values on the scriptName, scriptAuthor and optionally scriptVersion parameters. * Chained execution executes each of the scripts identified on the call in a sequential @@ -142,12 +142,12 @@ public RProjectExecution executeScript(String scriptName, /** * Execute a single script found on a URL/path or a chain of scripts found on a set of URLs/paths * on the current project. - *

+ *

* To execute a chain of repository-managed scripts on this call provide a comma-separated * list of values on the externalSource parameter. * Chained execution executes each of the scripts identified on the call in a sequential * fashion on the R session, with execution occuring in the order specified on the parameter list. - *

+ *

* POWER_USER privileges are required for this call. * * @throws RClientException if RClient fails to complete call. diff --git a/src/main/java/com/revo/deployr/client/api/RUserJobCalls.java b/src/main/java/com/revo/deployr/client/api/RUserJobCalls.java index 6a7b74f..e588704 100644 --- a/src/main/java/com/revo/deployr/client/api/RUserJobCalls.java +++ b/src/main/java/com/revo/deployr/client/api/RUserJobCalls.java @@ -28,7 +28,7 @@ public interface RUserJobCalls { /** * List jobs. * - * @return List + * @return List<RJob> * @throws RClientException if RClient fails to complete call. * @throws RSecurityException if DeployR server security conditions not met on call. */ @@ -72,7 +72,7 @@ public RJob submitJobCode(String jobName, * Submit a single repository-managed script or a chain of * repository-managed scripts (found in the root directory) * to execute as a job. - *

+ *

* To submit a chain of repository-managed scripts on this call provide a comma-separated * list of values on the scriptName, scriptAuthor and optionally scriptVersion parameters. * Chained execution executes each of the scripts identified on the call in a sequential @@ -96,7 +96,7 @@ public RJob submitJobScript(String jobName, /** * Submit a single repository-managed script or a chain of * repository-managed scripts to execute as a job. - *

+ *

* To submit a chain of repository-managed scripts on this call provide a comma-separated * list of values on the scriptName, scriptAuthor and optionally scriptVersion parameters. * Chained execution executes each of the scripts identified on the call in a sequential @@ -121,7 +121,7 @@ public RJob submitJobScript(String jobName, /** * Submit a single repository-managed script or a chain of repository-managed scripts * to execute as a job. - *

+ *

* To submit a chain of repository-managed scripts on this call provide a comma-separated * list of values on the scriptName, scriptAuthor and optionally scriptVersion parameters. * Chained execution executes each of the scripts identified on the call in a sequential @@ -142,7 +142,7 @@ public RJob submitJobScript(String jobName, /** * Submit a single repository-managed script or a chain of repository-managed scripts * to execute as a job. - *

+ *

* To submit a chain of repository-managed scripts on this call provide a comma-separated * list of values on the scriptName, scriptAuthor and optionally scriptVersion parameters. * Chained execution executes each of the scripts identified on the call in a sequential @@ -164,10 +164,10 @@ public RJob submitJobScript(String jobName, /** * Submit a single script found on a URL/path or a chain of scripts found on a set of URLs/paths * on the current project. - *

+ *

* To submit a chain of repository-managed scripts on this call provide a comma-separated * list of values on the externalSource parameter. - *

+ *

* POWER_USER privileges are required for this call. * * @return RJob diff --git a/src/main/java/com/revo/deployr/client/api/RUserProjectCalls.java b/src/main/java/com/revo/deployr/client/api/RUserProjectCalls.java index 83298d4..c3cdf38 100644 --- a/src/main/java/com/revo/deployr/client/api/RUserProjectCalls.java +++ b/src/main/java/com/revo/deployr/client/api/RUserProjectCalls.java @@ -64,7 +64,7 @@ public RProject createProject(ProjectCreationOptions options) /** * Create a pool of temporary projects. * - * @return List + * @return List<RProject> * @throws RClientException if RClient fails to complete call. * @throws RSecurityException if DeployR server security conditions not met on call. */ diff --git a/src/main/java/com/revo/deployr/client/api/RUserRepositoryDirectoryCalls.java b/src/main/java/com/revo/deployr/client/api/RUserRepositoryDirectoryCalls.java index 8d710b4..e1575d7 100644 --- a/src/main/java/com/revo/deployr/client/api/RUserRepositoryDirectoryCalls.java +++ b/src/main/java/com/revo/deployr/client/api/RUserRepositoryDirectoryCalls.java @@ -135,7 +135,7 @@ public RRepositoryDirectory createDirectory(String directory) /** * Copies one or more repository-managed files from a source * user directory to a destination user directory. - *

+ *

* If the files parameter is null, all files in the source * directory will be copied to the destination directory. * @@ -150,7 +150,7 @@ public void copyDirectory(String sourceDirectory, /** * Moves one or more repository-managed files from a source * user directory to a destination user directory. - *

+ *

* If the files parameter is null, all files in the source * directory will be moved to the destination directory. * @@ -166,7 +166,7 @@ public void moveDirectory(String sourceDirectory, * Uploads a set of files in a single zip archive into an existing * repository-managed user directory. The files are extracted from * the zip archive and placed file-by-file into the directory. - *

+ *

* The options.filename property is ignored on this call and * can be left blank. * diff --git a/src/main/java/com/revo/deployr/client/api/RUserRepositoryScriptCalls.java b/src/main/java/com/revo/deployr/client/api/RUserRepositoryScriptCalls.java index db787b2..484bbd0 100644 --- a/src/main/java/com/revo/deployr/client/api/RUserRepositoryScriptCalls.java +++ b/src/main/java/com/revo/deployr/client/api/RUserRepositoryScriptCalls.java @@ -26,7 +26,7 @@ public interface RUserRepositoryScriptCalls { /** * List scripts in user' default repository. * - * @return List + * @return List<RRepositoryFile> * @throws RClientException if RClient fails to complete call. * @throws RSecurityException if DeployR server security conditions not met on call. */ @@ -64,7 +64,7 @@ public List listScripts(String filename, /** * List scripts in user' external repository. * - * @return List + * @return List<RRepositoryFile> * @throws RClientException if RClient fails to complete call. * @throws RSecurityException if DeployR server security conditions not met on call. */ diff --git a/src/main/java/com/revo/deployr/client/data/RBooleanMatrix.java b/src/main/java/com/revo/deployr/client/data/RBooleanMatrix.java index 882abe3..e02e2fb 100644 --- a/src/main/java/com/revo/deployr/client/data/RBooleanMatrix.java +++ b/src/main/java/com/revo/deployr/client/data/RBooleanMatrix.java @@ -22,7 +22,7 @@ public interface RBooleanMatrix extends RData { /** * Gets the List-of-List of Boolean values for this RData. * - * @return List> value + * @return List<List<Boolean>> value * @see RData */ public List> getValue(); diff --git a/src/main/java/com/revo/deployr/client/data/RBooleanVector.java b/src/main/java/com/revo/deployr/client/data/RBooleanVector.java index 0367095..fdbc377 100644 --- a/src/main/java/com/revo/deployr/client/data/RBooleanVector.java +++ b/src/main/java/com/revo/deployr/client/data/RBooleanVector.java @@ -22,7 +22,7 @@ public interface RBooleanVector extends RData { /** * Gets the List of Boolean values for this RData. * - * @return List value + * @return List<Boolean> value * @see RData */ public List getValue(); diff --git a/src/main/java/com/revo/deployr/client/data/RDataFrame.java b/src/main/java/com/revo/deployr/client/data/RDataFrame.java index 47715cd..38b12b9 100644 --- a/src/main/java/com/revo/deployr/client/data/RDataFrame.java +++ b/src/main/java/com/revo/deployr/client/data/RDataFrame.java @@ -22,7 +22,7 @@ public interface RDataFrame extends RData { /** * Gets the List-of-RData value for this RData. * - * @return List value + * @return List<RData> value * @see RData */ public List getValue(); diff --git a/src/main/java/com/revo/deployr/client/data/RDateVector.java b/src/main/java/com/revo/deployr/client/data/RDateVector.java index b7706fa..6684ed0 100644 --- a/src/main/java/com/revo/deployr/client/data/RDateVector.java +++ b/src/main/java/com/revo/deployr/client/data/RDateVector.java @@ -23,7 +23,7 @@ public interface RDateVector extends RData { /** * Gets the List of Date values for this RData. * - * @return List value + * @return List<Date> value * @see RData */ public List getValue(); diff --git a/src/main/java/com/revo/deployr/client/data/RList.java b/src/main/java/com/revo/deployr/client/data/RList.java index b361df7..e160798 100644 --- a/src/main/java/com/revo/deployr/client/data/RList.java +++ b/src/main/java/com/revo/deployr/client/data/RList.java @@ -22,7 +22,7 @@ public interface RList extends RData { /** * Gets the List-of-RData value for this RData. * - * @return List value + * @return List<RData> value * @see RData */ public List getValue(); diff --git a/src/main/java/com/revo/deployr/client/data/RNumericMatrix.java b/src/main/java/com/revo/deployr/client/data/RNumericMatrix.java index 4c7af97..f7eb5cb 100644 --- a/src/main/java/com/revo/deployr/client/data/RNumericMatrix.java +++ b/src/main/java/com/revo/deployr/client/data/RNumericMatrix.java @@ -22,7 +22,7 @@ public interface RNumericMatrix extends RData { /** * Gets the List-of-List of Double values for this RData. * - * @return List> value + * @return List<List<Double>> value * @see RData */ public List> getValue(); diff --git a/src/main/java/com/revo/deployr/client/data/RNumericVector.java b/src/main/java/com/revo/deployr/client/data/RNumericVector.java index be32ff3..0bf6f9e 100644 --- a/src/main/java/com/revo/deployr/client/data/RNumericVector.java +++ b/src/main/java/com/revo/deployr/client/data/RNumericVector.java @@ -22,7 +22,7 @@ public interface RNumericVector extends RData { /** * Gets the List of Double values for this RData. * - * @return List value + * @return List<Double> value * @see RData */ public List getValue(); diff --git a/src/main/java/com/revo/deployr/client/data/RStringMatrix.java b/src/main/java/com/revo/deployr/client/data/RStringMatrix.java index 8d8ba95..5de4463 100644 --- a/src/main/java/com/revo/deployr/client/data/RStringMatrix.java +++ b/src/main/java/com/revo/deployr/client/data/RStringMatrix.java @@ -22,7 +22,7 @@ public interface RStringMatrix extends RData { /** * Gets the List-of-List of String values for this RData. * - * @return List> value + * @return List<List<String>> value * @see RData */ public List> getValue(); diff --git a/src/main/java/com/revo/deployr/client/data/RStringVector.java b/src/main/java/com/revo/deployr/client/data/RStringVector.java index e585ee1..795f8cf 100644 --- a/src/main/java/com/revo/deployr/client/data/RStringVector.java +++ b/src/main/java/com/revo/deployr/client/data/RStringVector.java @@ -22,7 +22,7 @@ public interface RStringVector extends RData { /** * Gets the List of String values for this RData. * - * @return List value + * @return List<String> value * @see RData */ public List getValue(); diff --git a/src/main/java/com/revo/deployr/client/factory/RClientFactory.java b/src/main/java/com/revo/deployr/client/factory/RClientFactory.java index c89d0f1..da062e8 100644 --- a/src/main/java/com/revo/deployr/client/factory/RClientFactory.java +++ b/src/main/java/com/revo/deployr/client/factory/RClientFactory.java @@ -28,7 +28,7 @@ public class RClientFactory { /** * Create connection at the specified DeployR URL. - *

+ *

* Concurrent call limit defaults to 200. * * @param deployrUrl url address of DeployR Server @@ -42,7 +42,7 @@ public static RClient createClient(String deployrUrl) /** * Create connection at the specified DeployR URL. - *

+ *

* Concurrent call limit defaults to 200. * * @param deployrUrl url address of DeployR Server diff --git a/src/main/java/com/revo/deployr/client/factory/RDataFactory.java b/src/main/java/com/revo/deployr/client/factory/RDataFactory.java index 3326da3..ed0ea3d 100644 --- a/src/main/java/com/revo/deployr/client/factory/RDataFactory.java +++ b/src/main/java/com/revo/deployr/client/factory/RDataFactory.java @@ -117,7 +117,7 @@ public static RDataTable createDataTable(List data) { /** * Create an RDataTable using the data found within the RData * instance provided on the call to intialize the table data. - *

+ *

* The following RData concrete types are all accepted on this * call: *