200: Add a variant option when obtaining a UnitFormat from

FormatService.

Task-Url: #200

Author: keilw

pom.xml

@@ -4,7 +4,7 @@
 	<modelVersion>4.0.0</modelVersion>
 	<groupId>javax.measure</groupId>
 	<artifactId>unit-api</artifactId>
-	<version>2.1.1-SNAPSHOT</version>
+	<version>2.1</version>
 	<name>Units of Measurement API</name>
 	<packaging>bundle</packaging>
 	<url>http://unitsofmeasurement.github.io/unit-api/</url>

src/main/java/javax/measure/format/ParserException.java

@@ -38,7 +38,7 @@
  * This interface represent the service to obtain instances of {@link UnitFormat} and {@link QuantityFormat}.
  *
  * @author <a href="mailto:werner@uom.technology">Werner Keil</a>
- * @version 2.0, November 4, 2020
+ * @version 2.1, November 16, 2020
  * @since 2.0
  */
 public interface FormatService {
@@ -93,10 +93,11 @@ public static enum FormatType {
      * Returns the unit format having the specified name or {@code null} if none.
      *
      * For example {@code getUnitFormat("Simple")} to return a simple {@link UnitFormat} implementation.<br>
-     * The variant is an arbitrary value to allow a variation of a <code>UnitFormat</code>, for example <code>case sensitive</code> vs. <code>case insensitive</code> <a href="https://ucum.org/ucum.html">UCUM</a> format. 
+     * The variant is an arbitrary value to allow a variation of a <code>UnitFormat</code>, for example <code>case sensitive</code> vs. <code>case insensitive</code> <a href="https://ucum.org/ucum.html">UCUM</a> format.
+     * <p>If no variant is applicable, the <code>UnitFormat</code> matching the name only is returned.</p> 
      * @param name
      *          the name of the format.
-     * @param variant Any arbitrary value used to indicate a variation of a <code>UnitFormat</code>.
+     * @param variant any arbitrary value used to indicate a variation of a <code>UnitFormat</code>.
      * @return the corresponding unit format.
      */
     UnitFormat getUnitFormat(String name, String variant);

src/main/java/javax/measure/spi/FormatService.java

@@ -30,7 +30,6 @@
 package javax.measure.test.format;
 
 import javax.measure.format.MeasurementParseException;
-import javax.measure.format.ParserException;
 
 import org.junit.jupiter.api.Test;
 import static org.junit.jupiter.api.Assertions.*;
@@ -49,22 +48,22 @@ public void testExceptionWithMessage() {
 
     @Test
     public void testOldExceptionWithMessageDataAndPos() {
-        assertThrows(ParserException.class, () -> {
-            throw new ParserException("Error", " ", 0);
+        assertThrows(MeasurementParseException.class, () -> {
+            throw new MeasurementParseException("Error", " ", 0);
         });
     }
 
     @Test
     public void testOldExceptionWithMessageAndPos() {
-        assertThrows(ParserException.class, () -> {
-            throw new ParserException("Error", 0);
+        assertThrows(MeasurementParseException.class, () -> {
+            throw new MeasurementParseException("Error", 0);
         });
     }
 
     @Test
     public void testOldExceptionWithCause() {
-        assertThrows(ParserException.class, () -> {
-            throw new ParserException(new IllegalArgumentException("Error"));
+        assertThrows(MeasurementParseException.class, () -> {
+            throw new MeasurementParseException(new IllegalArgumentException("Error"));
         });
     }
 }