Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Update copyright lines with new year.
[simgrid.git] / src / bindings / java / org / simgrid / msg / File.java
index e37b1f4..5263adb 100644 (file)
@@ -1,4 +1,4 @@
-/* Copyright (c) 2012-2014. The SimGrid Team.
+/* Copyright (c) 2012-2020. The SimGrid Team.
  * All rights reserved.                                                     */
 
 /* This program is free software; you can redistribute it and/or modify it
@@ -12,43 +12,43 @@ public class File {
        public static final int SEEK_END = 2;
        /**
         * Represents the bind between the java comm and the
-        * native C comm. You must never access it, since it is 
+        * native C comm. You must never access it, since it is
         * automatically set.
         */
        private long bind = 0;
        /**
         * Constructor, opens the file.
-        * @param path is the file location on the storage 
+        * @param path is the file location on the storage
         */
        public File(String path) {
                open(path);
        }
-       @Override
-       protected void finalize() {
 
-       }
        /**
-        * Opens the file whose name is the string pointed to by path.  
+        * Opens the file whose name is the string pointed to by path.
         * @param path is the file location on the storage
         */
        protected native void open(String path);
        /**
-        * Read elements of a file. 
+        * Read elements of a file.
         * @param size of each element
-        * @param nMemb is the number of elements of data to write 
+        * @param nMemb is the number of elements of data to write
+        * @return the actually read size
         */
        public native long read(long size, long nMemb);
+
        /**
-        * Write elements into a file. 
-        * @param size of each element  
-        * @param nMemb is the number of elements of data to write 
+        * Write elements into a file.
+        * @param size of each element
+        * @param nMemb is the number of elements of data to write
+        * @return the actually written size
         */
        public native long write(long size, long nMemb);
        /**
-        * Write elements into a file. 
+        * Write elements into a file.
         * @param offset : number of bytes to offset from origin
-        * @param origin : Position used as reference for the offset. It is specified by one of the following constants 
-        *                 defined in <stdio.h> exclusively to be used as arguments for this function (SEEK_SET = 
+        * @param origin : Position used as reference for the offset. It is specified by one of the following constants
+        *                 defined in <stdio.h> exclusively to be used as arguments for this function (SEEK_SET =
         *                 beginning of file, SEEK_CUR = current position of the file pointer, SEEK_END = end of file)
         */
        public native void seek(long offset, long origin);