sis-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From desruisse...@apache.org
Subject svn commit: r1422210 - in /sis/branches/JDK7/sis-utility/src/main/java/org/apache/sis/util: Characters.java iso/Types.java
Date Sat, 15 Dec 2012 09:47:13 GMT
Author: desruisseaux
Date: Sat Dec 15 09:47:12 2012
New Revision: 1422210

URL: http://svn.apache.org/viewvc?rev=1422210&view=rev
Log:
Minor documentation and API updates.
The purpose of the API change (replace 'char' argument by 'int') is to support code point
values.

Modified:
    sis/branches/JDK7/sis-utility/src/main/java/org/apache/sis/util/Characters.java
    sis/branches/JDK7/sis-utility/src/main/java/org/apache/sis/util/iso/Types.java

Modified: sis/branches/JDK7/sis-utility/src/main/java/org/apache/sis/util/Characters.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK7/sis-utility/src/main/java/org/apache/sis/util/Characters.java?rev=1422210&r1=1422209&r2=1422210&view=diff
==============================================================================
--- sis/branches/JDK7/sis-utility/src/main/java/org/apache/sis/util/Characters.java (original)
+++ sis/branches/JDK7/sis-utility/src/main/java/org/apache/sis/util/Characters.java Sat Dec
15 09:47:12 2012
@@ -107,7 +107,7 @@ public final class Characters extends St
      * @param  c The character to test.
      * @return {@code true} if the given character is a superscript.
      */
-    public static boolean isSuperScript(final char c) {
+    public static boolean isSuperScript(final int c) {
         switch (c) {
             case '¹':      // Legacy values in "Latin-1 supplement" space: 00B9, 00B2
and 00B3.
             case '²':      // Those values are outside the normal [2070 … 207F] range.
@@ -130,7 +130,7 @@ public final class Characters extends St
      * @param  c The character to test.
      * @return {@code true} if the given character is a subscript.
      */
-    public static boolean isSubScript(final char c) {
+    public static boolean isSubScript(final int c) {
         return (c>='₀' && c<='₎');
     }
 

Modified: sis/branches/JDK7/sis-utility/src/main/java/org/apache/sis/util/iso/Types.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK7/sis-utility/src/main/java/org/apache/sis/util/iso/Types.java?rev=1422210&r1=1422209&r2=1422210&view=diff
==============================================================================
--- sis/branches/JDK7/sis-utility/src/main/java/org/apache/sis/util/iso/Types.java (original)
+++ sis/branches/JDK7/sis-utility/src/main/java/org/apache/sis/util/iso/Types.java Sat Dec
15 09:47:12 2012
@@ -50,7 +50,7 @@ import org.apache.sis.internal.util.Defa
  *   <li>{@link #toInternationalString(CharSequence)} and {@link #toGenericName(Object,
NameFactory)}
  *       for creating name-related objects from various objects.</li>
  *   <li>{@link #getStandardName(Class)}, {@link #getListName(CodeList)} and {@link
#getCodeName(CodeList)}
- *       for fetching ISO names if possible, or Java names as a fallback.</li>
+ *       for fetching ISO names if possible.</li>
  *   <li>{@link #getCodeTitle(CodeList, Locale)}, {@link #getDescription(CodeList,
Locale)} and
  *       {@link #getDescription(Class, Locale)} for fetching human-readable descriptions.</li>
  *   <li>{@link #forStandardName(String)} and {@link #forCodeName(Class, String, boolean)}
for
@@ -65,12 +65,15 @@ import org.apache.sis.internal.util.Defa
 public final class Types extends Static {
     /**
      * The class loader to use for fetching GeoAPI resources.
+     * Since the resources are bundled in the GeoAPI JAR file,
+     * we use the instance that loaded GeoAPI for more determinist behavior.
      */
     private static final ClassLoader CLASSLOADER = UML.class.getClassLoader();
 
     /**
      * The types for ISO 19115 UML identifiers. The keys are UML identifiers. Values
      * are either class names as {@link String} objects, or the {@link Class} instances.
+     * This map will be built only when first needed.
      *
      * @see #forName(String)
      */
@@ -88,12 +91,19 @@ public final class Types extends Static 
      * Examples:
      *
      * <ul>
-     *   <li><code>getStandardName({@linkplain org.opengis.metadata.citation.Citation}.class)</code>
  returns {@code "CI_Citation"}.</li>
-     *   <li><code>getStandardName({@linkplain org.opengis.referencing.cs.AxisDirection}.class)</code>
returns {@code "CS_AxisDirection"}.</li>
+     *   <li><code>getStandardName({@linkplain org.opengis.metadata.citation.Citation}.class)</code>
+     *       (an interface) returns {@code "CI_Citation"}.</li>
+     *   <li><code>getStandardName({@linkplain org.opengis.referencing.cs.AxisDirection}.class)</code>
+     *       (a code list) returns {@code "CS_AxisDirection"}.</li>
      * </ul>
      *
+     * This method looks for the {@link UML} annotation on the given type. It does not search
for
+     * parent classes or interfaces if the given type is not directly annotated (i.e. {@code
@UML}
+     * annotations are not inherited). If no annotation is found, then this method does not
fallback
+     * on the Java name since, as the name implies, this method is about standard names.
+     *
      * @param  type The GeoAPI interface or code list from which to get the ISO name, or
{@code null}.
-     * @return The ISO name for the given type, or {@code null} if none or if the type is
{@code null}.
+     * @return The ISO name for the given type, or {@code null} if none or if the given type
is {@code null}.
      *
      * @see #forStandardName(String)
      */



Mime
View raw message