Javasci: fix java build, javadoc warnings 54/19754/3
Clément DAVID [Mon, 12 Feb 2018 13:52:15 +0000 (14:52 +0100)]
  * fully document the API
  * remove static type field, inline ScilabTypeEnum value

Change-Id: Ifb926867d594cb2cba1e1be8896e33ea0a7668c0

18 files changed:
scilab/modules/javasci/src/java/org/scilab/modules/javasci/JavasciException.java
scilab/modules/javasci/src/java/org/scilab/modules/javasci/Scilab.java
scilab/modules/types/src/java/org/scilab/modules/types/ScilabBoolean.java
scilab/modules/types/src/java/org/scilab/modules/types/ScilabBooleanReference.java
scilab/modules/types/src/java/org/scilab/modules/types/ScilabBooleanSparse.java
scilab/modules/types/src/java/org/scilab/modules/types/ScilabDouble.java
scilab/modules/types/src/java/org/scilab/modules/types/ScilabDoubleReference.java
scilab/modules/types/src/java/org/scilab/modules/types/ScilabInteger.java
scilab/modules/types/src/java/org/scilab/modules/types/ScilabIntegerReference.java
scilab/modules/types/src/java/org/scilab/modules/types/ScilabList.java
scilab/modules/types/src/java/org/scilab/modules/types/ScilabMList.java
scilab/modules/types/src/java/org/scilab/modules/types/ScilabPolynomial.java
scilab/modules/types/src/java/org/scilab/modules/types/ScilabSparse.java
scilab/modules/types/src/java/org/scilab/modules/types/ScilabString.java
scilab/modules/types/src/java/org/scilab/modules/types/ScilabTList.java
scilab/modules/types/src/java/org/scilab/modules/types/ScilabType.java
scilab/modules/types/src/java/org/scilab/modules/types/ScilabVariables.java
scilab/modules/types/src/java/org/scilab/modules/types/ScilabVariablesRefresh.java

index 7cb6c3f..9110534 100644 (file)
@@ -117,6 +117,7 @@ public abstract class JavasciException extends Exception {
 
     /**
      * Default constructor
+     * @param message the message to be printed
      */
     public JavasciException(String message) {
         super(message);
index b58f057..0e55658 100644 (file)
@@ -1,6 +1,7 @@
 /*
  * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
  * Copyright (C) 2010 - INRIA - Sylvestre LEDRU
+ * Copyright (C) 2018 - ESI Group - Clement DAVID
  *
  * Copyright (C) 2012 - 2016 - Scilab Enterprises
  *
@@ -30,7 +31,6 @@ import org.scilab.modules.types.ScilabBooleanSparse;
 import org.scilab.modules.types.ScilabInteger;
 import org.scilab.modules.types.ScilabPolynomial;
 import org.scilab.modules.types.ScilabSparse;
-import org.scilab.modules.javasci.Call_Scilab;
 import org.scilab.modules.javasci.JavasciException.AlreadyRunningException;
 import org.scilab.modules.javasci.JavasciException.InitializationException;
 import org.scilab.modules.javasci.JavasciException.UnsupportedTypeException;
@@ -68,6 +68,7 @@ public class Scilab {
      * <LI>Scilab data path is autodetected (SCI) </LI>
      * <LI>advanced features are disabled (no Java nor TCL/TK features) </LI>
      * </UL>
+     * @throws InitializationException when Scilab installation is not detected or the <pre>SCI</pre> variable is not setup correctly.
      */
     public Scilab() throws InitializationException {
         this(null, false);
@@ -83,6 +84,7 @@ public class Scilab {
      * <BR>
      * </code>
      * @param SCI provide the path to Scilab data
+     * @throws InitializationException when Scilab installation is not detected or the <pre>SCI</pre> variable is not setup correctly.
      */
     public Scilab(String SCI) throws InitializationException {
         this(SCI, false);
@@ -98,6 +100,7 @@ public class Scilab {
      * <BR>
      * </code>
      * @param advancedMode true enables the advanced mode (GUI, graphics, Tcl/Tk, sciNotes...). Smaller.
+     * @throws InitializationException when Scilab installation is not detected or the <pre>SCI</pre> variable is not setup correctly.
      */
     public Scilab(boolean advancedMode) throws InitializationException {
         this(null, advancedMode);
@@ -118,17 +121,18 @@ public class Scilab {
      * </code>
      * @param SCIPath the path to Scilab data
      * @param advancedMode true enables the advanced mode (GUI, graphics, Tcl/Tk, sciNotes...). Smaller.
+     * @throws InitializationException when Scilab installation is not detected or the <pre>SCI</pre> variable is not setup correctly.
      */
     public Scilab(String SCIPath, boolean advancedMode) throws InitializationException {
-        String SCI = SCIPath;
+        String sci = SCIPath;
         if (!System.getProperty("os.name").toLowerCase().contains("windows")) {
-            if (SCI == null) {
+            if (sci == null) {
                 // Auto detect
                 try {
-                    SCI = System.getProperty("SCI");
-                    if (SCI == null || SCI.length() == 0) {
-                        SCI = System.getenv("SCI");
-                        if (SCI == null || SCI.length() == 0) {
+                    sci = System.getProperty("SCI");
+                    if (sci == null || sci.length() == 0) {
+                        sci = System.getenv("SCI");
+                        if (sci == null || sci.length() == 0) {
                             throw new InitializationException("Auto detection of SCI failed.\nSCI empty.");
                         }
                     }
@@ -138,7 +142,7 @@ public class Scilab {
             }
         }
         this.advancedMode = advancedMode;
-        this.initScilab(SCI);
+        this.initScilab(sci);
 
     }
 
@@ -169,7 +173,7 @@ public class Scilab {
      * </code>
      * @return if the operation is successful
      * @throws AlreadyRunningException Scilab is already running
-     * @throws InitializationException Cannot start Scilab
+     * @throws JavasciException when the connection to Scilab encountered an issue.
      */
     public boolean open() throws JavasciException {
         int res = Call_Scilab.Call_ScilabOpen(this.SCI, this.advancedMode, null, -1);
@@ -204,6 +208,7 @@ public class Scilab {
      * </code>
      * @param job The job to run on startup
      * @return if the operation is successful
+     * @throws JavasciException when the connection to Scilab encountered an issue.
      */
     public boolean open(String job) throws JavasciException {
         if (!this.open()) {
@@ -227,6 +232,7 @@ public class Scilab {
      * </code>
      * @param jobs The serie of jobs to run on startup
      * @return if the operation is successful
+     * @throws JavasciException when the connection to Scilab encountered an issue.
      */
     public boolean open(String jobs[]) throws JavasciException {
         if (!this.open()) {
@@ -250,6 +256,8 @@ public class Scilab {
      * </code>
      * @param scriptFilename The script to execute on startup
      * @return if the operation is successful
+     * @throws JavasciException when the connection to Scilab encountered an issue.
+     * @throws FileNotFoundException if the passed <code>scriptFilename</code> is not a valid Scilab file.
      */
     public boolean open(File scriptFilename) throws JavasciException, FileNotFoundException {
         if (!this.open()) {
@@ -276,7 +284,7 @@ public class Scilab {
         try {
             this.execException(job);
             return true;
-        } catch (Exception e) {
+        } catch (ScilabErrorException e) {
             return false;
         }
     }
@@ -294,6 +302,7 @@ public class Scilab {
      * </code>
      * @param job the job to execute
      * @since 5.4.0
+     * @throws ScilabErrorException when the connection to Scilab or the Scilab execution encountered an issue.
      */
     public void execException(String job) throws ScilabErrorException {
         int result = Call_Scilab.SendScilabJob(job);
@@ -319,7 +328,7 @@ public class Scilab {
         try {
             this.execException(jobs);
             return true;
-        } catch (Exception e) {
+        } catch (ScilabErrorException e) {
             return false;
         }
     }
@@ -336,6 +345,7 @@ public class Scilab {
      * </code>
      * @param jobs the serie of job to execute
      * @since 5.4.0
+     * @throws ScilabErrorException when the connection to Scilab or the Scilab execution encountered an issue.
      */
     public void execException(String jobs[]) throws ScilabErrorException {
         int result = Call_Scilab.SendScilabJobs(jobs, jobs.length);
@@ -359,6 +369,8 @@ public class Scilab {
      * </code>
      * @param scriptFilename the script to execute
      * @since 5.4.0
+     * @throws FileNotFoundException if the passed <code>scriptFilename</code> is not a valid Scilab file.
+     * @throws ScilabErrorException when the connection to Scilab or the Scilab execution encountered an issue.
      */
     public void execException(File scriptFilename) throws FileNotFoundException, ScilabErrorException {
         if (!scriptFilename.exists()) {
@@ -381,6 +393,7 @@ public class Scilab {
      * </code>
      * @param scriptFilename the script to execute
      * @return if the operation is successful
+     * @throws FileNotFoundException if the passed <code>scriptFilename</code> is not a valid Scilab file.
      */
     public boolean exec(File scriptFilename) throws FileNotFoundException {
         if (!scriptFilename.exists()) {
@@ -604,6 +617,7 @@ public class Scilab {
      * <BR>
      * </code>
      * @param varname the name of the variable
+     * @param byref the data buffer is shared (not copied) between Scilab and the returned ScilabType value.
      * @return return the variable
      * @throws UnsupportedTypeException Type not managed yet.
      */
@@ -740,7 +754,7 @@ public class Scilab {
                         err = Call_Scilab.putInt(varname, sciInteger.getDataAsInt());
                         break;
                     case sci_uint64:
-                        //                    err = Call_Scilab.putUnsignedLong(varname, sciInteger.getData_());
+                    //                    err = Call_Scilab.putUnsignedLong(varname, sciInteger.getData_());
                     case sci_int64:
                         //                    err = Call_Scilab.putLong(varname, sciInteger.getData_());
                         break;
index 86d9888..f55f583 100644 (file)
@@ -39,7 +39,6 @@ import java.util.Arrays;
 public class ScilabBoolean implements ScilabType {
 
     private static final long serialVersionUID = 6511497080095473901L;
-    private static final ScilabTypeEnum type = ScilabTypeEnum.sci_boolean;
 
     private static final int VERSION = 0;
 
@@ -69,8 +68,9 @@ public class ScilabBoolean implements ScilabType {
     /**
      * Create an object from an array of array of boolean
      *
-     * @param data
-     *            the array of boolean
+     * @param varName the variable name
+     * @param data the array of boolean
+     * @param swaped true if the matrix is stored row by row
      */
     public ScilabBoolean(String varName, boolean[][] data, boolean swaped) {
         this.varName = varName;
@@ -92,6 +92,7 @@ public class ScilabBoolean implements ScilabType {
     /**
      * {@inheritDoc}
      */
+    @Override
     public boolean isReference() {
         return byref;
     }
@@ -145,6 +146,7 @@ public class ScilabBoolean implements ScilabType {
     /**
      * {@inheritDoc}
      */
+    @Override
     public String getVarName() {
         return varName;
     }
@@ -152,6 +154,7 @@ public class ScilabBoolean implements ScilabType {
     /**
      * {@inheritDoc}
      */
+    @Override
     public boolean isSwaped() {
         return swaped;
     }
@@ -164,7 +167,7 @@ public class ScilabBoolean implements ScilabType {
      */
     @Override
     public ScilabTypeEnum getType() {
-        return type;
+        return ScilabTypeEnum.sci_boolean;
     }
 
     /**
@@ -232,6 +235,7 @@ public class ScilabBoolean implements ScilabType {
     /**
      * {@inheritDoc}
      */
+    @Override
     public Object getSerializedObject() {
         return getData();
     }
index 4a73887..8411fcd 100644 (file)
@@ -36,15 +36,18 @@ import java.nio.IntBuffer;
  */
 public class ScilabBooleanReference extends ScilabBoolean {
 
-    private IntBuffer intBuffer;
+    private final IntBuffer intBuffer;
     private final int nbRows;
     private final int nbCols;
 
     /**
      * Create an object from an array of array of boolean
      *
+     * @param varName the variable name
      * @param data
      *            the array of boolean
+     * @param nbRows the number of rows
+     * @param nbCols the number of columns
      */
     public ScilabBooleanReference(String varName, IntBuffer data, int nbRows, int nbCols) {
         this.varName = varName;
@@ -68,6 +71,7 @@ public class ScilabBooleanReference extends ScilabBoolean {
     /**
      * {@inheritDoc}
      */
+    @Override
     public boolean getElement(final int i, final int j) {
         return intBuffer.get(i + nbRows * j) != 0;
     }
@@ -75,6 +79,7 @@ public class ScilabBooleanReference extends ScilabBoolean {
     /**
      * {@inheritDoc}
      */
+    @Override
     public void setElement(final int i, final int j, final boolean x) {
         intBuffer.put(i + nbRows * j, x ? 1 : 0);
     }
@@ -85,6 +90,7 @@ public class ScilabBooleanReference extends ScilabBoolean {
      * @param data
      *            array of boolean
      */
+    @Override
     public void setData(boolean[][] data) {
         ScilabTypeUtils.setPart(intBuffer, data);
     }
@@ -94,6 +100,7 @@ public class ScilabBooleanReference extends ScilabBoolean {
      *
      * @return the array of array of boolean
      */
+    @Override
     public boolean[][] getData() {
         boolean[][] b = new boolean[nbRows][nbCols];
         ScilabTypeUtils.setBuffer(b, intBuffer);
@@ -104,6 +111,7 @@ public class ScilabBooleanReference extends ScilabBoolean {
     /**
      * {@inheritDoc}
      */
+    @Override
     public Object getRawData() {
         return intBuffer;
     }
index b4e62e2..22c1a0e 100644 (file)
@@ -35,7 +35,6 @@ import java.util.List;
 public class ScilabBooleanSparse implements ScilabType {
 
     private static final long serialVersionUID = 879625048944109684L;
-    private static final ScilabTypeEnum type = ScilabTypeEnum.sci_boolean_sparse;
 
     private static final int VERSION = 0;
 
@@ -82,6 +81,7 @@ public class ScilabBooleanSparse implements ScilabType {
      *            the column position of each true
      * @param check
      *            if true the parameters validity is checked
+     * @throws ScilabSparseException if the sparse representation is invalid
      */
     public ScilabBooleanSparse(int rows, int cols, int nbItem, int[] nbItemRow, int[] colPos, boolean check) throws ScilabSparseException {
         this(rows, cols, nbItem, nbItemRow, colPos);
@@ -167,6 +167,7 @@ public class ScilabBooleanSparse implements ScilabType {
     /**
      * {@inheritDoc}
      */
+    @Override
     public boolean isReference() {
         return false;
     }
@@ -179,7 +180,7 @@ public class ScilabBooleanSparse implements ScilabType {
      */
     @Override
     public ScilabTypeEnum getType() {
-        return type;
+        return ScilabTypeEnum.sci_boolean_sparse;
     }
 
     /**
@@ -265,6 +266,7 @@ public class ScilabBooleanSparse implements ScilabType {
     /**
      * {@inheritDoc}
      */
+    @Override
     public String getVarName() {
         return varName;
     }
@@ -272,6 +274,7 @@ public class ScilabBooleanSparse implements ScilabType {
     /**
      * {@inheritDoc}
      */
+    @Override
     public boolean isSwaped() {
         return false;
     }
@@ -355,6 +358,7 @@ public class ScilabBooleanSparse implements ScilabType {
     /**
      * {@inheritDoc}
      */
+    @Override
     public Object getSerializedObject() {
         return new Object[] { new int[] { rows, cols }, nbItemRow, getScilabColPos() };
     }
index 1b50dc9..6a2871c 100644 (file)
@@ -46,7 +46,6 @@ import java.util.Arrays;
 public class ScilabDouble implements ScilabType {
 
     private static final long serialVersionUID = 879624048944109684L;
-    private static final ScilabTypeEnum type = ScilabTypeEnum.sci_matrix;
 
     private static final int VERSION = 0;
 
@@ -126,10 +125,12 @@ public class ScilabDouble implements ScilabType {
     /**
      * Constructor with a matrix of complex numbers
      *
+     * @param varName the variable name
      * @param realData
      *            the real part of the data
      * @param imagData
      *            the imaginary part of the data
+     * @param swaped true if the matrices are stored row by row
      */
     public ScilabDouble(String varName, double[][] realData, double[][] imagData, boolean swaped) {
         this(realData, imagData);
@@ -145,7 +146,7 @@ public class ScilabDouble implements ScilabType {
      */
     @Override
     public ScilabTypeEnum getType() {
-        return type;
+        return ScilabTypeEnum.sci_matrix;
     }
 
     /**
@@ -161,6 +162,7 @@ public class ScilabDouble implements ScilabType {
     /**
      * {@inheritDoc}
      */
+    @Override
     public boolean isReference() {
         return byref;
     }
@@ -215,6 +217,7 @@ public class ScilabDouble implements ScilabType {
     /**
      * {@inheritDoc}
      */
+    @Override
     public String getVarName() {
         return varName;
     }
@@ -222,6 +225,7 @@ public class ScilabDouble implements ScilabType {
     /**
      * {@inheritDoc}
      */
+    @Override
     public boolean isSwaped() {
         return swaped;
     }
@@ -325,6 +329,7 @@ public class ScilabDouble implements ScilabType {
     /**
      * {@inheritDoc}
      */
+    @Override
     public Object getSerializedObject() {
         if (isReal()) {
             return new Object[] { getRealPart() };
index 28a314b..007b34b 100644 (file)
@@ -43,8 +43,8 @@ import java.nio.DoubleBuffer;
  */
 public class ScilabDoubleReference extends ScilabDouble {
 
-    private DoubleBuffer realBuffer;
-    private DoubleBuffer imaginaryBuffer;
+    private final DoubleBuffer realBuffer;
+    private final DoubleBuffer imaginaryBuffer;
     private final int nbRows;
     private final int nbCols;
 
@@ -81,6 +81,7 @@ public class ScilabDoubleReference extends ScilabDouble {
      *
      * @return true, if the data are real only.
      */
+    @Override
     public boolean isReal() {
         return imaginaryBuffer == null || imaginaryBuffer.capacity() == 0;
     }
@@ -88,6 +89,7 @@ public class ScilabDoubleReference extends ScilabDouble {
     /**
      * {@inheritDoc}
      */
+    @Override
     public Object getRawRealPart() {
         return realBuffer;
     }
@@ -95,6 +97,7 @@ public class ScilabDoubleReference extends ScilabDouble {
     /**
      * {@inheritDoc}
      */
+    @Override
     public Object getRawImaginaryPart() {
         return imaginaryBuffer;
     }
@@ -120,6 +123,7 @@ public class ScilabDoubleReference extends ScilabDouble {
      *
      * @return the real part.
      */
+    @Override
     public double[][] getRealPart() {
         double[][] d = new double[nbRows][nbCols];
         ScilabTypeUtils.setBuffer(d, realBuffer);
@@ -132,6 +136,7 @@ public class ScilabDoubleReference extends ScilabDouble {
      * @param realPart
      *            the real part.
      */
+    @Override
     public void setRealPart(double[][] realPart) {
         ScilabTypeUtils.setPart(realBuffer, realPart);
     }
@@ -141,6 +146,7 @@ public class ScilabDoubleReference extends ScilabDouble {
      *
      * @return the imaginary part.
      */
+    @Override
     public double[][] getImaginaryPart() {
         double[][] d = new double[nbRows][nbCols];
         ScilabTypeUtils.setBuffer(d, imaginaryBuffer);
@@ -153,6 +159,7 @@ public class ScilabDoubleReference extends ScilabDouble {
      * @param imaginaryPart
      *            the imaginary part.
      */
+    @Override
     public void setImaginaryPart(double[][] imaginaryPart) {
         ScilabTypeUtils.setPart(imaginaryBuffer, imaginaryPart);
     }
@@ -160,6 +167,7 @@ public class ScilabDoubleReference extends ScilabDouble {
     /**
      * {@inheritDoc}
      */
+    @Override
     public double getRealElement(final int i, final int j) {
         return realBuffer.get(i + nbRows * j);
     }
@@ -167,6 +175,7 @@ public class ScilabDoubleReference extends ScilabDouble {
     /**
      * {@inheritDoc}
      */
+    @Override
     public double getImaginaryElement(final int i, final int j) {
         return imaginaryBuffer.get(i + nbRows * j);
     }
@@ -174,6 +183,7 @@ public class ScilabDoubleReference extends ScilabDouble {
     /**
      * {@inheritDoc}
      */
+    @Override
     public void setRealElement(final int i, final int j, final double x) {
         realBuffer.put(i + nbRows * j, x);
     }
@@ -181,6 +191,7 @@ public class ScilabDoubleReference extends ScilabDouble {
     /**
      * {@inheritDoc}
      */
+    @Override
     public void setImaginaryElement(final int i, final int j, final double x) {
         imaginaryBuffer.put(i + nbRows * j, x);
     }
@@ -188,6 +199,7 @@ public class ScilabDoubleReference extends ScilabDouble {
     /**
      * {@inheritDoc}
      */
+    @Override
     public void setElement(final int i, final int j, final double x, final double y) {
         realBuffer.put(i + nbRows * j, x);
         imaginaryBuffer.put(i + nbRows * j, x);
index 0d0bb36..2b0bf38 100644 (file)
@@ -38,7 +38,6 @@ import java.util.Arrays;
 public class ScilabInteger implements ScilabType {
 
     private static final long serialVersionUID = 1759633801332932450L;
-    private static final ScilabTypeEnum type = ScilabTypeEnum.sci_ints;
 
     private static final int VERSION = 0;
 
@@ -107,10 +106,12 @@ public class ScilabInteger implements ScilabType {
     /**
      * Constructor with values
      *
+     * @param varName the variable name
      * @param data
      *            the values
      * @param bUnsigned
      *            true, if the values are unsigned; false if they are signed.
+     * @param swaped true if the matrices are stored row by row
      */
     public ScilabInteger(String varName, byte[][] data, boolean bUnsigned, boolean swaped) {
         this.setData(data, bUnsigned);
@@ -121,10 +122,12 @@ public class ScilabInteger implements ScilabType {
     /**
      * Constructor with values
      *
+     * @param varName the variable name
      * @param data
      *            the values
      * @param bUnsigned
      *            true, if the values are unsigned; false if they are signed.
+     * @param swaped true if the matrices are stored row by row
      */
     public ScilabInteger(String varName, short[][] data, boolean bUnsigned, boolean swaped) {
         this.setData(data, bUnsigned);
@@ -135,10 +138,12 @@ public class ScilabInteger implements ScilabType {
     /**
      * Constructor with values
      *
+     * @param varName the variable name
      * @param data
      *            the values
      * @param bUnsigned
      *            true, if the values are unsigned; false if they are signed.
+     * @param swaped true if the matrices are stored row by row
      */
     public ScilabInteger(String varName, int[][] data, boolean bUnsigned, boolean swaped) {
         this.setData(data, bUnsigned);
@@ -149,10 +154,12 @@ public class ScilabInteger implements ScilabType {
     /**
      * Constructor with values
      *
+     * @param varName the variable name
      * @param data
      *            the values
      * @param bUnsigned
      *            true, if the values are unsigned; false if they are signed.
+     * @param swaped true if the matrices are stored row by row
      */
     public ScilabInteger(String varName, long[][] data, boolean bUnsigned, boolean swaped) {
         this.setData(data, bUnsigned);
@@ -213,6 +220,8 @@ public class ScilabInteger implements ScilabType {
      *
      * @param value
      *            the unique value
+     * @param bUnsigned
+     *            true, if these values are unsigned; false otherwise.
      */
     public ScilabInteger(byte value, boolean bUnsigned) {
         this(value);
@@ -224,6 +233,8 @@ public class ScilabInteger implements ScilabType {
      *
      * @param value
      *            the unique value
+     * @param bUnsigned
+     *            true, if these values are unsigned; false otherwise.
      */
     public ScilabInteger(short value, boolean bUnsigned) {
         this(value);
@@ -235,6 +246,8 @@ public class ScilabInteger implements ScilabType {
      *
      * @param value
      *            the unique value
+     * @param bUnsigned
+     *            true, if these values are unsigned; false otherwise.
      */
     public ScilabInteger(int value, boolean bUnsigned) {
         this(value);
@@ -246,6 +259,8 @@ public class ScilabInteger implements ScilabType {
      *
      * @param value
      *            the unique value
+     * @param bUnsigned
+     *            true, if these values are unsigned; false otherwise.
      */
     public ScilabInteger(long value, boolean bUnsigned) {
         this(value);
@@ -328,7 +343,7 @@ public class ScilabInteger implements ScilabType {
      */
     @Override
     public ScilabTypeEnum getType() {
-        return type;
+        return ScilabTypeEnum.sci_ints;
     }
 
     /**
@@ -439,35 +454,35 @@ public class ScilabInteger implements ScilabType {
      * Manage the old representation of IntegerType
      *
      * @param typeName
-     *            the typeName (TYPE8, TYPE16, TYPE32, TYPE64)
+     *            the typeName (type8, type16, type32, type64)
      * @param unsigned
      *            unsigned or not
      * @return the converted type to ScilabIntegerTypeEnum. null is cannot
-     *         convert
+         convert
      */
     public static ScilabIntegerTypeEnum convertOldType(String typeName, boolean unsigned) {
-        if (typeName.equals("TYPE8")) {
+        if (typeName.equals("type8")) {
             if (unsigned) {
                 return ScilabIntegerTypeEnum.sci_uint8;
             } else {
                 return ScilabIntegerTypeEnum.sci_int8;
             }
         }
-        if (typeName.equals("TYPE16")) {
+        if (typeName.equals("type16")) {
             if (unsigned) {
                 return ScilabIntegerTypeEnum.sci_uint16;
             } else {
                 return ScilabIntegerTypeEnum.sci_int16;
             }
         }
-        if (typeName.equals("TYPE32")) {
+        if (typeName.equals("type32")) {
             if (unsigned) {
                 return ScilabIntegerTypeEnum.sci_uint32;
             } else {
                 return ScilabIntegerTypeEnum.sci_int32;
             }
         }
-        if (typeName.equals("TYPE64")) {
+        if (typeName.equals("type64")) {
             if (unsigned) {
                 return ScilabIntegerTypeEnum.sci_uint64;
             } else {
@@ -558,6 +573,7 @@ public class ScilabInteger implements ScilabType {
     /**
      * {@inheritDoc}
      */
+    @Override
     public boolean isReference() {
         return byref;
     }
@@ -591,6 +607,7 @@ public class ScilabInteger implements ScilabType {
     /**
      * {@inheritDoc}
      */
+    @Override
     public String getVarName() {
         return varName;
     }
@@ -598,6 +615,7 @@ public class ScilabInteger implements ScilabType {
     /**
      * {@inheritDoc}
      */
+    @Override
     public boolean isSwaped() {
         return swaped;
     }
@@ -801,6 +819,7 @@ public class ScilabInteger implements ScilabType {
     /**
      * {@inheritDoc}
      */
+    @Override
     public Object getSerializedObject() {
         return new Object[] { new int[] { this.getPrec().swigValue() }, getCorrectData() };
     }
index 3f3881b..4beab5b 100644 (file)
@@ -130,6 +130,7 @@ public class ScilabIntegerReference extends ScilabInteger {
     /**
      * {@inheritDoc}
      */
+    @Override
     public byte getByteElement(final int i, final int j) {
         return byteBuffer.get(i + nbRows * j);
     }
@@ -137,6 +138,7 @@ public class ScilabIntegerReference extends ScilabInteger {
     /**
      * {@inheritDoc}
      */
+    @Override
     public short getShortElement(final int i, final int j) {
         return shortBuffer.get(i + nbRows * j);
     }
@@ -144,6 +146,7 @@ public class ScilabIntegerReference extends ScilabInteger {
     /**
      * {@inheritDoc}
      */
+    @Override
     public int getIntElement(final int i, final int j) {
         return intBuffer.get(i + nbRows * j);
     }
@@ -151,6 +154,7 @@ public class ScilabIntegerReference extends ScilabInteger {
     /**
      * {@inheritDoc}
      */
+    @Override
     public long getLongElement(final int i, final int j) {
         return longBuffer.get(i + nbRows * j);
     }
@@ -158,6 +162,7 @@ public class ScilabIntegerReference extends ScilabInteger {
     /**
      * {@inheritDoc}
      */
+    @Override
     public void setByteElement(final int i, final int j, final byte x) {
         byteBuffer.put(i + nbRows * j, x);
     }
@@ -165,6 +170,7 @@ public class ScilabIntegerReference extends ScilabInteger {
     /**
      * {@inheritDoc}
      */
+    @Override
     public void setShortElement(final int i, final int j, final short x) {
         shortBuffer.put(i + nbRows * j, x);
     }
@@ -172,6 +178,7 @@ public class ScilabIntegerReference extends ScilabInteger {
     /**
      * {@inheritDoc}
      */
+    @Override
     public void setIntElement(final int i, final int j, final int x) {
         intBuffer.put(i + nbRows * j, x);
     }
@@ -179,6 +186,7 @@ public class ScilabIntegerReference extends ScilabInteger {
     /**
      * {@inheritDoc}
      */
+    @Override
     public void setLongElement(final int i, final int j, final long x) {
         longBuffer.put(i + nbRows * j, x);
     }
@@ -191,6 +199,7 @@ public class ScilabIntegerReference extends ScilabInteger {
      * @param bUnsigned
      *            true, if these values are unsigned; false otherwise.
      */
+    @Override
     public void setData(byte[][] data, boolean bUnsigned) {
         ScilabTypeUtils.setPart(byteBuffer, data);
         if (bUnsigned) {
@@ -208,6 +217,7 @@ public class ScilabIntegerReference extends ScilabInteger {
      * @param bUnsigned
      *            true, if these values are unsigned; false otherwise.
      */
+    @Override
     public void setData(short[][] data, boolean bUnsigned) {
         ScilabTypeUtils.setPart(shortBuffer, data);
         if (bUnsigned) {
@@ -225,6 +235,7 @@ public class ScilabIntegerReference extends ScilabInteger {
      * @param bUnsigned
      *            true, if these values are unsigned; false otherwise.
      */
+    @Override
     public void setData(int[][] data, boolean bUnsigned) {
         ScilabTypeUtils.setPart(intBuffer, data);
         if (bUnsigned) {
@@ -242,6 +253,7 @@ public class ScilabIntegerReference extends ScilabInteger {
      * @param bUnsigned
      *            true, if these values are unsigned; false otherwise.
      */
+    @Override
     public void setData(long[][] data, boolean bUnsigned) {
         ScilabTypeUtils.setPart(longBuffer, data);
         if (bUnsigned) {
@@ -256,6 +268,7 @@ public class ScilabIntegerReference extends ScilabInteger {
      *
      * @return the values as short
      */
+    @Override
     public short[][] getDataAsShort() {
         short[][] d = new short[nbRows][nbCols];
         ScilabTypeUtils.setBuffer(d, shortBuffer);
@@ -268,6 +281,7 @@ public class ScilabIntegerReference extends ScilabInteger {
      *
      * @return the values as byte
      */
+    @Override
     public byte[][] getDataAsByte() {
         byte[][] d = new byte[nbRows][nbCols];
         ScilabTypeUtils.setBuffer(d, byteBuffer);
@@ -280,6 +294,7 @@ public class ScilabIntegerReference extends ScilabInteger {
      *
      * @return the values as int
      */
+    @Override
     public int[][] getDataAsInt() {
         int[][] d = new int[nbRows][nbCols];
         ScilabTypeUtils.setBuffer(d, intBuffer);
@@ -292,6 +307,7 @@ public class ScilabIntegerReference extends ScilabInteger {
      *
      * @return the values as long
      */
+    @Override
     public long[][] getDataAsLong() {
         long[][] d = new long[nbRows][nbCols];
         ScilabTypeUtils.setBuffer(d, longBuffer);
@@ -349,6 +365,7 @@ public class ScilabIntegerReference extends ScilabInteger {
     /**
      * {@inheritDoc}
      */
+    @Override
     public Object getRawData() {
         switch (this.getPrec()) {
             case sci_int8:
@@ -371,6 +388,7 @@ public class ScilabIntegerReference extends ScilabInteger {
     /**
      * {@inheritDoc}
      */
+    @Override
     public Object getCorrectData() {
         switch (this.getPrec()) {
             case sci_int8:
index 3153fb4..06f00b4 100644 (file)
@@ -40,7 +40,6 @@ import java.util.Collection;
 public class ScilabList extends ArrayList<ScilabType> implements ScilabType {
 
     private static final long serialVersionUID = 6884293176289980909L;
-    private static final ScilabTypeEnum type = ScilabTypeEnum.sci_list;
 
     private static final int VERSION = 0;
 
@@ -69,6 +68,7 @@ public class ScilabList extends ArrayList<ScilabType> implements ScilabType {
      *
      * Note that the first element of this collection is the header used by
      * Scilab to find each field name.
+     * @param varName the variable name
      */
     public ScilabList(String varName) {
         super();
@@ -87,6 +87,7 @@ public class ScilabList extends ArrayList<ScilabType> implements ScilabType {
     /**
      * {@inheritDoc}
      */
+    @Override
     public boolean isReference() {
         return false;
     }
@@ -94,6 +95,7 @@ public class ScilabList extends ArrayList<ScilabType> implements ScilabType {
     /**
      * {@inheritDoc}
      */
+    @Override
     public String getVarName() {
         return varName;
     }
@@ -101,6 +103,7 @@ public class ScilabList extends ArrayList<ScilabType> implements ScilabType {
     /**
      * {@inheritDoc}
      */
+    @Override
     public boolean isSwaped() {
         return false;
     }
@@ -125,7 +128,7 @@ public class ScilabList extends ArrayList<ScilabType> implements ScilabType {
      */
     @Override
     public ScilabTypeEnum getType() {
-        return type;
+        return ScilabTypeEnum.sci_list;
     }
 
     /**
@@ -148,6 +151,7 @@ public class ScilabList extends ArrayList<ScilabType> implements ScilabType {
      *
      * @return a serialized ScilabList/
      */
+    @Override
     public Object[] getSerializedObject() {
         int[] types = new int[size()];
         Object[] items = new Object[types.length + 1];
index 6d9f28e..4215a44 100644 (file)
@@ -42,7 +42,6 @@ import java.util.Map;
 public class ScilabMList extends ArrayList<ScilabType> implements ScilabType {
 
     private static final long serialVersionUID = 3224510024213901841L;
-    private static final ScilabTypeEnum type = ScilabTypeEnum.sci_mlist;
 
     private static final int VERSION = 0;
 
@@ -63,6 +62,7 @@ public class ScilabMList extends ArrayList<ScilabType> implements ScilabType {
      *
      * Note that the first element of this collection is the header used by
      * Scilab to find each field name.
+     * @param varName the variable name
      */
     public ScilabMList(String varName) {
         super();
@@ -114,6 +114,7 @@ public class ScilabMList extends ArrayList<ScilabType> implements ScilabType {
     /**
      * {@inheritDoc}
      */
+    @Override
     public boolean isReference() {
         return false;
     }
@@ -121,6 +122,7 @@ public class ScilabMList extends ArrayList<ScilabType> implements ScilabType {
     /**
      * {@inheritDoc}
      */
+    @Override
     public String getVarName() {
         return varName;
     }
@@ -128,6 +130,7 @@ public class ScilabMList extends ArrayList<ScilabType> implements ScilabType {
     /**
      * {@inheritDoc}
      */
+    @Override
     public boolean isSwaped() {
         return false;
     }
@@ -198,7 +201,7 @@ public class ScilabMList extends ArrayList<ScilabType> implements ScilabType {
      */
     @Override
     public ScilabTypeEnum getType() {
-        return type;
+        return ScilabTypeEnum.sci_mlist;
     }
 
     /**
@@ -221,6 +224,7 @@ public class ScilabMList extends ArrayList<ScilabType> implements ScilabType {
      *
      * @return a serialized ScilabList/
      */
+    @Override
     public Object[] getSerializedObject() {
         int[] types = new int[size()];
         Object[] items = new Object[types.length + 1];
index 9f4d7ac..c6b8bf4 100644 (file)
@@ -33,7 +33,6 @@ import java.util.Arrays;
 public class ScilabPolynomial implements ScilabType {
 
     private static final long serialVersionUID = 870624048944109684L;
-    private static final ScilabTypeEnum type = ScilabTypeEnum.sci_poly;
 
     private static final int VERSION = 0;
 
@@ -69,6 +68,7 @@ public class ScilabPolynomial implements ScilabType {
      *
      * @param data
      *            the unique polynomial
+     * @param polyVarName the polynomial variable name
      */
     public ScilabPolynomial(double[] data, String polyVarName) {
         this(data);
@@ -97,6 +97,7 @@ public class ScilabPolynomial implements ScilabType {
      *            the real part
      * @param imagData
      *            the complex part
+     * @param polyVarName the polynomial variable name
      */
     public ScilabPolynomial(double[] realData, double[] imagData, String polyVarName) {
         this(realData, imagData);
@@ -119,6 +120,7 @@ public class ScilabPolynomial implements ScilabType {
      *
      * @param data
      *            the data
+     * @param polyVarName the polynomial variable name
      */
     public ScilabPolynomial(double[][][] data, String polyVarName) {
         this(data);
@@ -145,6 +147,7 @@ public class ScilabPolynomial implements ScilabType {
      *            the real part of the data
      * @param imagData
      *            the imaginary part of the data
+     * @param polyVarName the polynomial variable name
      */
     public ScilabPolynomial(double[][][] realData, double[][][] imagData, String polyVarName) {
         this(realData, imagData);
@@ -176,6 +179,7 @@ public class ScilabPolynomial implements ScilabType {
     /**
      * {@inheritDoc}
      */
+    @Override
     public boolean isReference() {
         return false;
     }
@@ -188,7 +192,7 @@ public class ScilabPolynomial implements ScilabType {
      */
     @Override
     public ScilabTypeEnum getType() {
-        return type;
+        return ScilabTypeEnum.sci_poly;
     }
 
     /**
@@ -264,6 +268,7 @@ public class ScilabPolynomial implements ScilabType {
     /**
      * {@inheritDoc}
      */
+    @Override
     public String getVarName() {
         return varName;
     }
@@ -271,6 +276,7 @@ public class ScilabPolynomial implements ScilabType {
     /**
      * {@inheritDoc}
      */
+    @Override
     public boolean isSwaped() {
         return swaped;
     }
@@ -347,6 +353,7 @@ public class ScilabPolynomial implements ScilabType {
     /**
      * {@inheritDoc}
      */
+    @Override
     public Object getSerializedObject() {
         if (isReal()) {
             return new Object[] { polyVarName, realPart };
index 960129b..fc3f2b1 100644 (file)
@@ -28,14 +28,12 @@ import java.util.List;
  * This class is {@link java.io.Serializable} and any modification could impact
  * load and store of data (Xcos files, Javasci saved data, etc...).<br>
  * <br>
- * //TODO Sly : ajouter de la doc
  *
  * @see org.scilab.modules.javasci.Scilab
  */
 public class ScilabSparse implements ScilabType {
 
     private static final long serialVersionUID = 879625048944109684L;
-    private static final ScilabTypeEnum type = ScilabTypeEnum.sci_sparse;
 
     private static final int VERSION = 0;
 
@@ -107,6 +105,7 @@ public class ScilabSparse implements ScilabType {
      *            the non null data
      * @param check
      *            if true the parameters validity is checked
+     * @throws ScilabSparseException if the passed arguments are not a valid sparse representation
      */
     public ScilabSparse(int rows, int cols, int nbItem, int[] nbItemRow, int[] colPos, double[] data, boolean check) throws ScilabSparseException {
         this(rows, cols, nbItem, nbItemRow, colPos, data);
@@ -163,6 +162,7 @@ public class ScilabSparse implements ScilabType {
      *            the non null imaginary data
      * @param check
      *            if true the parameters validity is checked
+     * @throws ScilabSparseException if the passed arguments are not a valid sparse representation
      */
     public ScilabSparse(int rows, int cols, int nbItem, int[] nbItemRow, int[] colPos, double[] real, double[] imag, boolean check)
     throws ScilabSparseException {
@@ -362,6 +362,7 @@ public class ScilabSparse implements ScilabType {
     /**
      * {@inheritDoc}
      */
+    @Override
     public boolean isReference() {
         return false;
     }
@@ -374,7 +375,7 @@ public class ScilabSparse implements ScilabType {
      */
     @Override
     public ScilabTypeEnum getType() {
-        return type;
+        return ScilabTypeEnum.sci_sparse;
     }
 
     /**
@@ -732,6 +733,7 @@ public class ScilabSparse implements ScilabType {
     /**
      * {@inheritDoc}
      */
+    @Override
     public String getVarName() {
         return varName;
     }
@@ -739,6 +741,7 @@ public class ScilabSparse implements ScilabType {
     /**
      * {@inheritDoc}
      */
+    @Override
     public boolean isSwaped() {
         return false;
     }
@@ -923,6 +926,7 @@ public class ScilabSparse implements ScilabType {
     /**
      * {@inheritDoc}
      */
+    @Override
     public Object getSerializedObject() {
         if (isReal()) {
             return new Object[] { new int[] { getHeight(), getWidth() }, getNbItemRow(), getScilabColPos(), getRealPart() };
index 519fcdd..d2a9dab 100644 (file)
@@ -38,7 +38,6 @@ import java.util.Arrays;
 public class ScilabString implements ScilabType {
 
     private static final long serialVersionUID = 359802519980180085L;
-    private static final ScilabTypeEnum type = ScilabTypeEnum.sci_strings;
 
     private static final int VERSION = 0;
 
@@ -66,8 +65,10 @@ public class ScilabString implements ScilabType {
     /**
      * Constructor with data.
      *
+     * @param varName the variable name
      * @param data
      *            the associated data.
+     * @param swaped true if the matrices are stored row by row
      */
     public ScilabString(String varName, String[][] data, boolean swaped) {
         this.varName = varName;
@@ -125,7 +126,7 @@ public class ScilabString implements ScilabType {
      */
     @Override
     public ScilabTypeEnum getType() {
-        return type;
+        return ScilabTypeEnum.sci_strings;
     }
 
     /**
@@ -138,6 +139,7 @@ public class ScilabString implements ScilabType {
     /**
      * {@inheritDoc}
      */
+    @Override
     public String getVarName() {
         return varName;
     }
@@ -145,6 +147,7 @@ public class ScilabString implements ScilabType {
     /**
      * {@inheritDoc}
      */
+    @Override
     public boolean isSwaped() {
         return swaped;
     }
@@ -152,6 +155,7 @@ public class ScilabString implements ScilabType {
     /**
      * {@inheritDoc}
      */
+    @Override
     public boolean isReference() {
         return false;
     }
@@ -213,6 +217,7 @@ public class ScilabString implements ScilabType {
     /**
      * {@inheritDoc}
      */
+    @Override
     public Object getSerializedObject() {
         return data;
     }
index a14d8d6..cd15ff9 100644 (file)
@@ -42,7 +42,6 @@ import java.util.Map;
 public class ScilabTList extends ArrayList<ScilabType> implements ScilabType {
 
     private static final long serialVersionUID = 8080160982092586620L;
-    private static final ScilabTypeEnum type = ScilabTypeEnum.sci_tlist;
 
     private static final int VERSION = 0;
 
@@ -63,6 +62,7 @@ public class ScilabTList extends ArrayList<ScilabType> implements ScilabType {
      *
      * Note that the first element of this collection is the header used by
      * Scilab to find each field name.
+     * @param varName the variable name
      */
     public ScilabTList(String varName) {
         super();
@@ -114,6 +114,7 @@ public class ScilabTList extends ArrayList<ScilabType> implements ScilabType {
     /**
      * {@inheritDoc}
      */
+    @Override
     public boolean isReference() {
         return false;
     }
@@ -121,6 +122,7 @@ public class ScilabTList extends ArrayList<ScilabType> implements ScilabType {
     /**
      * {@inheritDoc}
      */
+    @Override
     public String getVarName() {
         return varName;
     }
@@ -128,6 +130,7 @@ public class ScilabTList extends ArrayList<ScilabType> implements ScilabType {
     /**
      * {@inheritDoc}
      */
+    @Override
     public boolean isSwaped() {
         return false;
     }
@@ -186,7 +189,7 @@ public class ScilabTList extends ArrayList<ScilabType> implements ScilabType {
      */
     @Override
     public ScilabTypeEnum getType() {
-        return type;
+        return ScilabTypeEnum.sci_tlist;
     }
 
     /**
@@ -221,6 +224,7 @@ public class ScilabTList extends ArrayList<ScilabType> implements ScilabType {
      *
      * @return a serialized ScilabList/
      */
+    @Override
     public Object[] getSerializedObject() {
         int[] types = new int[size()];
         Object[] items = new Object[types.length + 1];
index b17a89c..fb72b94 100644 (file)
@@ -81,6 +81,7 @@ public interface ScilabType extends Externalizable, Cloneable {
      *            the object we want to compare
      * @return true if the two objects are equals, false otherwise
      */
+    @Override
     public boolean equals(Object obj);
 
     /**
@@ -97,5 +98,6 @@ public interface ScilabType extends Externalizable, Cloneable {
      *
      * @return the pretty print
      */
+    @Override
     String toString();
 }
index b7cd956..18611ca 100644 (file)
@@ -126,6 +126,8 @@ public final class ScilabVariables {
      *            will contain the data
      * @param data
      *            the data
+     * @param rows number of rows
+     * @param cols number of columns
      * @param handlerId
      *            the handler id
      */
@@ -170,6 +172,10 @@ public final class ScilabVariables {
      * @param indexes
      *            an integer array with the indexes of the (sub)*-list which
      *            will contain the data
+     * @param real complex real part data buffer
+     * @param imag complex imaginary part data buffer
+     * @param rows number of rows
+     * @param cols number of columns
      * @param handlerId
      *            the handler id
      */
@@ -214,6 +220,8 @@ public final class ScilabVariables {
      *            will contain the data
      * @param data
      *            the data
+     * @param rows number of rows
+     * @param cols number of columns
      * @param handlerId
      *            the handler id
      */
@@ -258,6 +266,8 @@ public final class ScilabVariables {
      *            will contain the data
      * @param data
      *            the data
+     * @param rows number of rows
+     * @param cols number of columns
      * @param handlerId
      *            the handler id
      */
@@ -302,6 +312,8 @@ public final class ScilabVariables {
      *            will contain the data
      * @param data
      *            the data
+     * @param rows number of rows
+     * @param cols number of columns
      * @param handlerId
      *            the handler id
      */
@@ -346,6 +358,8 @@ public final class ScilabVariables {
      *            will contain the data
      * @param data
      *            the data
+     * @param rows number of rows
+     * @param cols number of columns
      * @param handlerId
      *            the handler id
      */
@@ -390,6 +404,8 @@ public final class ScilabVariables {
      *            will contain the data
      * @param data
      *            the data
+     * @param rows number of rows
+     * @param cols number of columns
      * @param handlerId
      *            the handler id
      */
@@ -434,6 +450,8 @@ public final class ScilabVariables {
      *            will contain the data
      * @param data
      *            the data
+     * @param rows number of rows
+     * @param cols number of columns
      * @param handlerId
      *            the handler id
      */
@@ -478,6 +496,8 @@ public final class ScilabVariables {
      *            will contain the data
      * @param data
      *            the data
+     * @param rows number of rows
+     * @param cols number of columns
      * @param handlerId
      *            the handler id
      */
@@ -522,6 +542,8 @@ public final class ScilabVariables {
      *            will contain the data
      * @param data
      *            the data
+     * @param rows number of rows
+     * @param cols number of columns
      * @param handlerId
      *            the handler id
      */
@@ -803,6 +825,7 @@ public final class ScilabVariables {
      *
      * @param varName
      *            the variable name
+     * @param nbItems number of element in the list
      * @param indexes
      *            an integer array with the indexes of the (sub)*-list which
      *            will contain the data
@@ -842,6 +865,7 @@ public final class ScilabVariables {
      * Call when the list filling is finished a * @param indexes an integer
      * array with the indexes of the (sub)*-list which will contain the data
      *
+     * @param indexes to close
      * @param handlerId
      *            the handler id
      */
index a3e09c5..33eadd1 100644 (file)
@@ -38,6 +38,7 @@ public final class ScilabVariablesRefresh implements ScilabVariablesHandler {
     /**
      * {@inheritDoc}
      */
+    @Override
     public void handle(ScilabType var) {
         Object[] listeners = eventListeners.getListenerList();
         ScilabVariablesEvent event = null;