sis-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From desruisse...@apache.org
Subject svn commit: r1409067 - in /sis/branches/JDK7: ./ sis-utility/src/main/java/org/apache/sis/util/collection/
Date Wed, 14 Nov 2012 02:58:26 GMT
Author: desruisseaux
Date: Wed Nov 14 02:58:25 2012
New Revision: 1409067

URL: http://svn.apache.org/viewvc?rev=1409067&view=rev
Log:
Minor javadoc updates.

Modified:
    sis/branches/JDK7/pom.xml
    sis/branches/JDK7/sis-utility/src/main/java/org/apache/sis/util/collection/Cache.java
    sis/branches/JDK7/sis-utility/src/main/java/org/apache/sis/util/collection/DefaultTreeTable.java
    sis/branches/JDK7/sis-utility/src/main/java/org/apache/sis/util/collection/TableColumn.java
    sis/branches/JDK7/sis-utility/src/main/java/org/apache/sis/util/collection/TreeTable.java

Modified: sis/branches/JDK7/pom.xml
URL: http://svn.apache.org/viewvc/sis/branches/JDK7/pom.xml?rev=1409067&r1=1409066&r2=1409067&view=diff
==============================================================================
--- sis/branches/JDK7/pom.xml (original)
+++ sis/branches/JDK7/pom.xml Wed Nov 14 02:58:25 2012
@@ -490,7 +490,7 @@ Apache SIS is a toolkit for describing l
           <tags>
             <tag><placement>t</placement> <name>goal</name>
    <head>Maven goal:</head></tag>
             <tag><placement>t</placement> <name>phase</name>
   <head>Maven phase:</head></tag>
-            <tag><placement>a</placement> <name>category</name>
<head>Category:</head></tag>
+            <tag><placement>X</placement> <name>category</name>
<head>Category:</head></tag>
             <tag><placement>a</placement> <name>todo</name>
    <head>TODO:</head></tag>
           </tags>
           <taglets>

Modified: sis/branches/JDK7/sis-utility/src/main/java/org/apache/sis/util/collection/Cache.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK7/sis-utility/src/main/java/org/apache/sis/util/collection/Cache.java?rev=1409067&r1=1409066&r2=1409067&view=diff
==============================================================================
--- sis/branches/JDK7/sis-utility/src/main/java/org/apache/sis/util/collection/Cache.java
(original)
+++ sis/branches/JDK7/sis-utility/src/main/java/org/apache/sis/util/collection/Cache.java
Wed Nov 14 02:58:25 2012
@@ -67,9 +67,7 @@ import static org.apache.sis.internal.ut
  *                     return createMyObject(key);
  *                 }
  *             });
- *         } catch (MyCheckedException e) {
- *             throw e;
- *         } catch (RuntimeException e) {
+ *         } catch (MyCheckedException | RuntimeException e) {
  *             throw e;
  *         } catch (Exception e) {
  *             throw new UndeclaredThrowableException(e);

Modified: sis/branches/JDK7/sis-utility/src/main/java/org/apache/sis/util/collection/DefaultTreeTable.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK7/sis-utility/src/main/java/org/apache/sis/util/collection/DefaultTreeTable.java?rev=1409067&r1=1409066&r2=1409067&view=diff
==============================================================================
--- sis/branches/JDK7/sis-utility/src/main/java/org/apache/sis/util/collection/DefaultTreeTable.java
(original)
+++ sis/branches/JDK7/sis-utility/src/main/java/org/apache/sis/util/collection/DefaultTreeTable.java
Wed Nov 14 02:58:25 2012
@@ -31,9 +31,29 @@ import org.apache.sis.util.resources.Err
  * construction time. The list of columns is unmodifiable, but the {@linkplain #getRoot()
root node}
  * can be modified.
  *
- * <p>{@code DefaultTreeTable} accepts arbitrary {@link TreeTable.Node} implementations.
- * However it is likely to be safer and more memory efficient when used together with the
- * implementation provided in the {@link Node} inner class.</p>
+ * Example:
+ *
+ * {@preformat java
+ *     class CityLocation {
+ *         public static final TableColumn<String> CITY_NAME  = new MyColumn<>(String.class);
+ *         public static final TableColumn<Float>  LATITUDE   = new MyColumn<>(Float
.class);
+ *         public static final TableColumn<Float>  LONGTITUDE = new MyColumn<>(Float
.class);
+ *
+ *         TreeTable createTable() {
+ *             DefaultTreeTable table = new DefaultTreeTable(CITY_NAME, LATITUDE, LONGITUDE);
+ *             TreeTable.Node   city  = new DefaultTreeTable.Node(table);
+ *             city.setValue(CITY_NAME, "Rimouski");
+ *             city.setValue(LATITUDE,   48.470417);
+ *             city.setValue(LONGITUDE, -68.521385);
+ *             table.setRoot(city);
+ *             return table;
+ *         }
+ *     }
+ * }
+ *
+ * {@code DefaultTreeTable} accepts arbitrary {@link TreeTable.Node} implementations.
+ * However it is likely to be safer and more memory efficient when used together with
+ * the implementation provided in the {@link Node} inner class.
  *
  * @author  Martin Desruisseaux (Geomatys)
  * @since   0.3
@@ -192,7 +212,8 @@ public class DefaultTreeTable implements
 
     /**
      * A {@link TreeTable.Node} implementation which can store values for a pre-defined list
-     * of columns.
+     * of columns. The list of columns is specified by a {@link TreeTable}, or inherited
from
+     * a parent node.
      *
      * <p>The {@linkplain #getChildren() list of children} provided by this class is
<cite>live</cite>:
      * adding a {@code Node} child to that list will automatically set its parent to {@code
this},

Modified: sis/branches/JDK7/sis-utility/src/main/java/org/apache/sis/util/collection/TableColumn.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK7/sis-utility/src/main/java/org/apache/sis/util/collection/TableColumn.java?rev=1409067&r1=1409066&r2=1409067&view=diff
==============================================================================
--- sis/branches/JDK7/sis-utility/src/main/java/org/apache/sis/util/collection/TableColumn.java
(original)
+++ sis/branches/JDK7/sis-utility/src/main/java/org/apache/sis/util/collection/TableColumn.java
Wed Nov 14 02:58:25 2012
@@ -27,14 +27,18 @@ import org.opengis.util.InternationalStr
  *
  * {@preformat java
  *     class CityLocation {
- *         static final TableColumn<String> CITY_NAME  = new MyColumn<>(String.class);
- *         static final TableColumn<Float>  LATITUDE   = new MyColumn<>(Float
.class);
- *         static final TableColumn<Float>  LONGTITUDE = new MyColumn<>(Float
.class);
+ *         public static final TableColumn<String> CITY_NAME  = new MyColumn<>(String.class);
+ *         public static final TableColumn<Float>  LATITUDE   = new MyColumn<>(Float
.class);
+ *         public static final TableColumn<Float>  LONGTITUDE = new MyColumn<>(Float
.class);
  *
- *         void myMethod(TreeTable.Node myNode) {
- *             String city      = myNode.getValue(CITY_NAME);
- *             float  latitude  = myNode.getValue(LATITUDE );
- *             float  longitude = myNode.getValue(LONGITUDE);
+ *         private String city;
+ *         private float  latitude;
+ *         private float  longitude;
+ *
+ *         CityLocation(TreeTable.Node myNode) {
+ *             city      = myNode.getValue(CITY_NAME);
+ *             latitude  = myNode.getValue(LATITUDE );
+ *             longitude = myNode.getValue(LONGITUDE);
  *         }
  *     }
  * }

Modified: sis/branches/JDK7/sis-utility/src/main/java/org/apache/sis/util/collection/TreeTable.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK7/sis-utility/src/main/java/org/apache/sis/util/collection/TreeTable.java?rev=1409067&r1=1409066&r2=1409067&view=diff
==============================================================================
--- sis/branches/JDK7/sis-utility/src/main/java/org/apache/sis/util/collection/TreeTable.java
(original)
+++ sis/branches/JDK7/sis-utility/src/main/java/org/apache/sis/util/collection/TreeTable.java
Wed Nov 14 02:58:25 2012
@@ -146,7 +146,7 @@ public interface TreeTable {
          * The user object is for information purpose only and does not appear in the rendered
tree.
          * It is typically a Java object whose content is splitted into the various table
columns.
          *
-         * <blockquote><font size="-1"><b>Example:<.b>
+         * <blockquote><font size="-1"><b>Example:</b>
          * If a {@code CityLocation} class is defined as a (<var>city name</var>,
<var>latitude</var>,
          * <var>longitude</var>) tuple, then a {@code TreeTable.Node} could be
defined to have
          * 3 columns for the above 3 tuple components, and the user object could be the original



Mime
View raw message