Skip to main content

[datafx~datafx2:100] add some javadoc

  • From:
  • To:
  • Subject: [datafx~datafx2:100] add some javadoc
  • Date: Fri, 30 Aug 2013 10:47:06 +0000

Project:    datafx
Repository: datafx2
Revision:   100
Author:     johanvos
Date:       2013-08-30 10:48:17 UTC
Link:       

Log Message:
------------
[maven-release-plugin]  copy for tag datafx-core-2.0b2
[maven-release-plugin] prepare for next development iteration
add some javadoc


Revisions:
----------
98
99
100


Modified Paths:
---------------
.hgtags
datafx-core/pom.xml
datafx-core/src/main/java/org/datafx/provider/DataProvider.java
datafx-core/src/main/java/org/datafx/provider/PublishingTask.java
datafx-core/src/main/java/org/datafx/provider/SingleObjectDataProvider.java
datafx-core/src/main/java/org/datafx/reader/DataReader.java
datafx-core/src/main/java/org/datafx/writer/WriteBackProvider.java


Diffs:
------
diff -r 8d41e5e587a4 -r a97333401ac9 .hgtags
--- a/.hgtags   Mon Aug 12 10:59:16 2013 +0200
+++ b/.hgtags   Mon Aug 12 11:01:19 2013 +0200
@@ -6,3 +6,4 @@
 0000000000000000000000000000000000000000 2.0-b1
 0000000000000000000000000000000000000000 2.0-b1
 f486a6f2b4100fbe4a994658ca7f8a5ed771bb3a 2.0-b1
+8d41e5e587a4dc9a61988f7475275390d15de0b3 datafx-core-2.0b2


diff -r a97333401ac9 -r cf60cbd0885d datafx-core/pom.xml
--- a/datafx-core/pom.xml       Mon Aug 12 11:01:19 2013 +0200
+++ b/datafx-core/pom.xml       Mon Aug 12 11:01:26 2013 +0200
@@ -8,7 +8,7 @@
 
        <groupId>org.javafxdata</groupId>
        <artifactId>datafx-core</artifactId>
-       <version>2.0b2</version>
+       <version>2.0b3-SNAPSHOT</version>
        <packaging>jar</packaging>
 
        <name>datafx-core</name>


diff -r 15a0f2dd1d93 -r 381d11f1d7a7 
datafx-core/src/main/java/org/datafx/provider/DataProvider.java
--- a/datafx-core/src/main/java/org/datafx/provider/DataProvider.java   Mon 
Aug 12 10:00:48 2013 +0200
+++ b/datafx-core/src/main/java/org/datafx/provider/DataProvider.java   Fri 
Aug 30 12:48:17 2013 +0200
@@ -8,23 +8,19 @@
  * @author johan
  */
 public interface DataProvider<T> {
-        /**
+    /**
      * A ObservableValue that wraps the provided Data. Maybe at the creation
      * of this class the provided data is not loaded. So you can add a
      * ChangeLister to the ObservableValue. The listener will be invoked 
once the
      * data is loaded.
      *
-     * @return
+     * @return the data obtained by this DataProvider.
      */
     ObservableValue<T> getData();
 
     /**
-     * Starts to retrieve the data in Background and returns the worker for 
some
-     * monitoring. I don't return a Service here like in ObjectDataSource. A
-     * Service has methods like start(), restart(), getExecutor() that should
-     * not called from outside because the ObjectReceiver should manage all 
the
-     * threading. With a Worker you can only check the state of the process. 
The
-     * Worker has the generic type T. So you can access the loaded Data by 
the
+     * Starts to retrieve the data in a background thread and returns the 
Worker for
+     * monitoring. The Worker has the generic type T. So you can access the 
loaded data by the
      * Worker once it's finished.
      *
      * @return Worker that retrieves the data

diff -r 15a0f2dd1d93 -r 381d11f1d7a7 
datafx-core/src/main/java/org/datafx/provider/PublishingTask.java
--- a/datafx-core/src/main/java/org/datafx/provider/PublishingTask.java Mon 
Aug 12 10:00:48 2013 +0200
+++ b/datafx-core/src/main/java/org/datafx/provider/PublishingTask.java Fri 
Aug 30 12:48:17 2013 +0200
@@ -26,7 +26,8 @@
         return publishedValues;
     }
 
-    @Override protected final ObservableList<T> call() throws Exception {
+    @Override 
+    protected final ObservableList<T> call() throws Exception {
         callTask();
         return publishedValues;
     }

diff -r 15a0f2dd1d93 -r 381d11f1d7a7 
datafx-core/src/main/java/org/datafx/provider/SingleObjectDataProvider.java
--- 
a/datafx-core/src/main/java/org/datafx/provider/SingleObjectDataProvider.java 
      Mon Aug 12 10:00:48 2013 +0200
+++ 
b/datafx-core/src/main/java/org/datafx/provider/SingleObjectDataProvider.java 
      Fri Aug 30 12:48:17 2013 +0200
@@ -28,8 +28,6 @@
  */
 public class SingleObjectDataProvider<T> implements DataProvider<T>,
         WriteBackProvider<T>{
-    // we can't make this final since the result objectproperty can be set 
via setResultObjectProperty.
-
     private ObjectProperty<T> objectProperty;
     private Executor executor;
     private final DataReader<T> reader;

diff -r 15a0f2dd1d93 -r 381d11f1d7a7 
datafx-core/src/main/java/org/datafx/reader/DataReader.java
--- a/datafx-core/src/main/java/org/datafx/reader/DataReader.java       Mon 
Aug 12 10:00:48 2013 +0200
+++ b/datafx-core/src/main/java/org/datafx/reader/DataReader.java       Fri 
Aug 30 12:48:17 2013 +0200
@@ -9,9 +9,24 @@
  * @author johan
  */
 public interface DataReader<T> {
-       
+       /**
+         * Obtain the next entity of data. In case the data is a single 
entity, 
+         * this method returns all data. In case the data is a list, this 
method
+         * returns the next entity and moves a pointer to the subsequent 
entity, if any
+         * @return the next available data entity or null if no new data can 
be
+         * retrieved
+         */
        public T get();
        
+        /**
+         * Check if more data is available on this DataReader. This method 
will only
+         * return false if no data is available. It should not return false 
in case
+         * data will be available at a later time.
+         * Calling this method on a DataReader that does not support lists 
always returns
+         * false
+         * @return true in case more data is available and obtainable via a 
@link get call,
+         * false otherwise.
+         */
        public boolean next();
        
 }

diff -r 15a0f2dd1d93 -r 381d11f1d7a7 
datafx-core/src/main/java/org/datafx/writer/WriteBackProvider.java
--- a/datafx-core/src/main/java/org/datafx/writer/WriteBackProvider.java      
  Mon Aug 12 10:00:48 2013 +0200
+++ b/datafx-core/src/main/java/org/datafx/writer/WriteBackProvider.java      
  Fri Aug 30 12:48:17 2013 +0200
@@ -3,7 +3,7 @@
 /**
  * 
  * Classes implementing this interface are capable of writing changes to
- * entities of type <T> back to the original dataprovider.
+ * entities of type T back to the original dataprovider.
  *
  * @author johan
  */






[datafx~datafx2:100] add some javadoc

johanvos 08/30/2013
 
 
Close
loading
Please Confirm
Close