sis-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From desruisse...@apache.org
Subject svn commit: r1565297 - in /sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/io/wkt: Formatter.java Symbols.java
Date Thu, 06 Feb 2014 15:06:49 GMT
Author: desruisseaux
Date: Thu Feb  6 15:06:49 2014
New Revision: 1565297

URL: http://svn.apache.org/r1565297
Log:
Minor javadoc.

Modified:
    sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/io/wkt/Formatter.java
    sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/io/wkt/Symbols.java

Modified: sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/io/wkt/Formatter.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/io/wkt/Formatter.java?rev=1565297&r1=1565296&r2=1565297&view=diff
==============================================================================
--- sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/io/wkt/Formatter.java
[UTF-8] (original)
+++ sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/io/wkt/Formatter.java
[UTF-8] Thu Feb  6 15:06:49 2014
@@ -376,7 +376,7 @@ public class Formatter implements Locali
      * @param  info The object to look for a preferred identifier, or {@code null} if none.
      * @return The preferred identifier, or {@code null} if none.
      */
-    public ReferenceIdentifier getIdentifier(final IdentifiedObject info) {
+    private ReferenceIdentifier getIdentifier(final IdentifiedObject info) {
         ReferenceIdentifier first = null;
         if (info != null) {
             final Collection<ReferenceIdentifier> identifiers = info.getIdentifiers();
@@ -739,6 +739,11 @@ public class Formatter implements Locali
     /**
      * Appends a code list.
      *
+     * <blockquote><table class="compact" style="text-align:left">
+     *   <tr><th>Position:</th>  <td>current line</td></tr>
+     *   <tr><th>Color key:</th> <td>{@link ElementKind#CODE_LIST}</td></tr>
+     * </table></blockquote>
+     *
      * @param code The code list to append to the WKT, or {@code null} if none.
      */
     public void append(final CodeList<?> code) {
@@ -754,6 +759,11 @@ public class Formatter implements Locali
      * Appends a character string between quotes.
      * The {@linkplain Symbols#getSeparator() element separator} will be written before the
text if needed.
      *
+     * <blockquote><table class="compact" style="text-align:left">
+     *   <tr><th>Position:</th>  <td>current line</td></tr>
+     *   <tr><th>Color key:</th> <td>given</td></tr>
+     * </table></blockquote>
+     *
      * @param text The string to format to the WKT, or {@code null} if none.
      * @param type The key of the colors to apply if syntax coloring is enabled.
      */
@@ -833,6 +843,11 @@ public class Formatter implements Locali
      * Appends a date.
      * The {@linkplain Symbols#getSeparator() element separator} will be written before the
date if needed.
      *
+     * <blockquote><table class="compact" style="text-align:left">
+     *   <tr><th>Position:</th>  <td>current line</td></tr>
+     *   <tr><th>Color key:</th> <td>none</td></tr>
+     * </table></blockquote>
+     *
      * @param date The date to append to the WKT, or {@code null} if none.
      */
     public void append(final Date date) {
@@ -846,6 +861,11 @@ public class Formatter implements Locali
      * Appends a boolean value.
      * The {@linkplain Symbols#getSeparator() element separator} will be written before the
boolean if needed.
      *
+     * <blockquote><table class="compact" style="text-align:left">
+     *   <tr><th>Position:</th>  <td>current line</td></tr>
+     *   <tr><th>Color key:</th> <td>none</td></tr>
+     * </table></blockquote>
+     *
      * @param value The boolean to append to the WKT.
      */
     public void append(final boolean value) {
@@ -857,6 +877,11 @@ public class Formatter implements Locali
      * Appends an integer value.
      * The {@linkplain Symbols#getSeparator() element separator} will be written before the
number if needed.
      *
+     * <blockquote><table class="compact" style="text-align:left">
+     *   <tr><th>Position:</th>  <td>current line</td></tr>
+     *   <tr><th>Color key:</th> <td>{@link ElementKind#INTEGER}</td></tr>
+     * </table></blockquote>
+     *
      * @param number The integer to append to the WKT.
      */
     public void append(final long number) {
@@ -871,6 +896,11 @@ public class Formatter implements Locali
      * Appends an floating point value.
      * The {@linkplain Symbols#getSeparator() element separator} will be written before the
number if needed.
      *
+     * <blockquote><table class="compact" style="text-align:left">
+     *   <tr><th>Position:</th>  <td>current line</td></tr>
+     *   <tr><th>Color key:</th> <td>{@link ElementKind#NUMBER}</td></tr>
+     * </table></blockquote>
+     *
      * @param number The floating point value to append to the WKT.
      */
     public void append(final double number) {
@@ -914,6 +944,11 @@ public class Formatter implements Locali
      *
      * {@example <code>append(SI.KILOMETRE)</code> will append "<code>LENGTHUNIT["km",
1000]</code>" to the WKT.}
      *
+     * <blockquote><table class="compact" style="text-align:left">
+     *   <tr><th>Position:</th>  <td>depending the previous element</td></tr>
+     *   <tr><th>Color key:</th> <td>none</td></tr>
+     * </table></blockquote>
+     *
      * @param unit The unit to append to the WKT, or {@code null} if none.
      */
     public void append(final Unit<?> unit) {

Modified: sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/io/wkt/Symbols.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/io/wkt/Symbols.java?rev=1565297&r1=1565296&r2=1565297&view=diff
==============================================================================
--- sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/io/wkt/Symbols.java [UTF-8]
(original)
+++ sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/io/wkt/Symbols.java [UTF-8]
Thu Feb  6 15:06:49 2014
@@ -32,7 +32,7 @@ import static org.apache.sis.util.Argume
  * The two constants defined in this class, namely {@link #SQUARE_BRACKETS} and {@link #CURLY_BRACKETS},
  * define the symbols for ISO 19162 compliant WKT formatting. Their properties are:
  *
- * <blockquote><table class="compact">
+ * <blockquote><table class="compact" style="text-align:left>
  *   <tr>
  *     <td>Locale for number format:</td>
  *     <td>{@link Locale#ROOT}</td>



Mime
View raw message