0.6.11

.github/workflows/maven.yml

@@ -12,7 +12,7 @@ on:
 jobs:
   build:
 
-    runs-on: macos-13
+    runs-on: macos-latest
 
     steps:
     - name: Checkout repository

README.md

@@ -10,13 +10,13 @@
 
 mavenized [JSR-113](https://jcp.org/en/jsr/detail?id=113) modified aka JSAPI2
 
- * this JSAPI version 2.2.1 (**CAUTION** since 2.2.0, versions are my original (modified from SUN's original))
+ * this JSAPI version 2.2.1 (**CAUTION**: starting from version 2.2.0, these are my own versions, modified from SUN's original.)
    * 2.0.6
      * DOES NOT support the J2ME platform (like CLDC 1.0, MIDP 1.0)
      * volume property is enabled
    * 2.2.0 support service loader mechanism.
-     * `speech.properties` and `EngineManager#registerEngineListFactory` works, but no more needed
-   * 2.2.1 add voice comparison level for `SpeechLocal#match()`
+     * `speech.properties` and `EngineManager#registerEngineListFactory` work, but no longer needed
+   * 2.2.1 add voice comparison level for [`SpeechLocal#match()`](javax.speech/src/main/java/javax/speech/SpeechLocale.java)
 
 ## Install
 

javax.speech/pom.xml

@@ -6,7 +6,7 @@
   <parent>
     <groupId>org.jvoicexml</groupId>
     <artifactId>jsapi2</artifactId>
-    <version>0.6.10</version>
+    <version>0.6.11</version>
   </parent>
 
   <artifactId>javax.speech</artifactId>

javax.speech/src/main/java/javax/speech/EngineManager.java

@@ -49,7 +49,7 @@
  * The EngineManager provides the ability to
  * locate, select and create speech Engine instances.
  * <p>
- * The createEngine method creates create speech Engines.
+ * The createEngine method creates speech Engines.
  * It accepts a single parameter that
  * defines the required properties for the Engine to create.
  * The parameter is a subclass of EngineMode corresponding to a
@@ -92,7 +92,7 @@
  * Locale is treated specially in the selection to ensure that language is
  * always considered when selecting an engine.
  * If a locale is not provided, the default locale
- * (java.util.Locale.getDefault) is used.
+ * ({@code java.util.Locale.getDefault}) is used.
  * <p>
  * The selection procedure is:
  * <p>
@@ -109,7 +109,7 @@
  * the required properties.
  * Amongst the matching engines, give preference to:
  * <p>
- * A running engine (EngineMode.getRunning is true),
+ * A running engine ({@link EngineMode#getRunning} is true),
  * An engine that matches the default Locale's country.
  * <p>
  * When more than one engine is a legal match in the final step,
@@ -149,8 +149,8 @@
  * </pre>
  * <p>
  * This line is interpreted as "the EngineListFactory object for the
- * com.acme.recognizer engine is the class called
- * com.acme.recognizer.AcmeEngineListFactory.
+ * {@code com.acme.recognizer} engine is the class called
+ * {@code com.acme.recognizer.AcmeEngineListFactory}.
  * When it is first called, the EngineManager class will attempt to create an
  * instance of each EngineListFactory object and will ensure that it implements
  * the EngineListFactory interface.
@@ -186,7 +186,7 @@ public class EngineManager {
             Class<?> clazz = Class.forName("javax.speech.EngineManager");
             input = clazz.getResourceAsStream("/speech.properties");
         } catch (ClassNotFoundException e) {
-            throw new IllegalArgumentException(e.getMessage());
+            throw new IllegalArgumentException(e);
         }
         if (input != null) {
             Properties props = new Properties();
@@ -196,7 +196,7 @@ public class EngineManager {
                 // Close input
                 input.close();
             } catch (IOException e) {
-                // Ignore.
+                logger.log(Level.DEBUG, e.getMessage(), e);
             }
 
             Enumeration<?> keys = props.keys();
@@ -206,7 +206,7 @@ public class EngineManager {
                 try {
                     registerEngineListFactory(className);
                 } catch (IllegalArgumentException | SecurityException | EngineException e) {
-                    // Ignore.
+                    logger.log(Level.DEBUG, e.getMessage(), e);
                 }
             }
         }
@@ -217,7 +217,7 @@ public class EngineManager {
      * Lists EngineMode objects for available engine modes
      * that match the required properties.
      * <p>
-     * If the require parameter is null, then all known Engines are listed.
+     * If the {@code require} parameter is null, then all known Engines are listed.
      * <p>
      * Returns a zero-length list if no Engines are available or if no Engines
      * have the required properties. (The method never returns null).

javax.speech/src/main/java/javax/speech/SpeechLocale.java

@@ -26,7 +26,6 @@
 
 package javax.speech;
 
-
 import java.lang.System.Logger;
 import java.lang.System.Logger.Level;
 
@@ -35,9 +34,10 @@
 
 /**
  * TODO this class should be replaced by Locale?
+ * <p>
  * system property
  * <li>javax.speech.SpeechLocale.comparisonStrictness ... set strictness for #match() method values are
- *                                                        STRICT</li>
+ *                                                        LENIENT or STRICT (default)</li>
  *
  * @since 2.0.6
  */
@@ -66,26 +66,26 @@ public final class SpeechLocale {
         FRENCH = new SpeechLocale("fr");
         GERMAN = new SpeechLocale("de");
 
-        String defaultLanguage = System.getProperty("microedition.locale");
+        String defaultLanguage = System.getProperty("microedition.locale"); // TODO cldc is deprecated
         if (defaultLanguage == null) {
             defaultLanguage = "en";
         }
         DEFAULT_LOCALE = new SpeechLocale(defaultLanguage);
     }
 
-    private String language;
+    private final String language;
 
-    private String country;
+    private final String country;
 
-    private String variant;
+    private final String variant;
 
     /**
      * Convert new iso639 codes to the old ones.
      *
      * @param language the language to check
      * @return the appropriate code
      */
-    private String convertLanguage(String language) {
+    private static String convertLanguage(String language) {
         if (language.isEmpty())
             return language;
         language = language.toLowerCase();
@@ -117,14 +117,17 @@ public static SpeechLocale[] getAvailableLocales() {
         return new SpeechLocale[] {ENGLISH, US, FRENCH, GERMAN};
     }
 
+    /** @return not null */
     public String getLanguage() {
         return language;
     }
 
+    /** @return not null */
     public String getCountry() {
         return country;
     }
 
+    /** @return not null */
     public String getVariant() {
         return variant;
     }
@@ -139,9 +142,12 @@ public int hashCode() {
         return result;
     }
 
-    /** for {@link #match(SpeechLocale)} */
+    /**
+     * for {@link #match(SpeechLocale)}
+     * @since 2.2.1
+     */
     private enum ComparisonStrictness {
-        /** match if on of them is matched */
+        /** match if specified ones are matched */
         LENIENT,
         /** compare all */
         STRICT;
@@ -198,6 +204,10 @@ public boolean equals(Object obj) {
     }
 
     /**
+     * when {@link #comparisonStrictness} is {@link ComparisonStrictness#STRICT} it's needed perfect match
+     * (country & language & variant), when {@link #comparisonStrictness} is {@link ComparisonStrictness#LENIENT}
+     * it's needed language & country (if it's specified).
+     *
      * @since 2.2.1 using {@link #comparisonStrictness} for comparison strictness.
      * @param require null means any match
      */

org.jvoicexml.jsapi2.demo.helloworld/pom.xml

@@ -6,7 +6,7 @@
   <parent>
     <groupId>org.jvoicexml</groupId>
     <artifactId>jsapi2</artifactId>
-    <version>0.6.10</version>
+    <version>0.6.11</version>
   </parent>
 
   <artifactId>org.jvoicexml.jsapi2.demo.helloworld</artifactId>
@@ -20,7 +20,6 @@
           <trimStackTrace>false</trimStackTrace>
           <argLine>
             -Djava.util.logging.config.file=${project.build.testOutputDirectory}/logging.properties
-            -Dvavi.util.logging.VaviFormatter.extraClassMethod=sun\.util\.logging\.internal\.LoggingProviderImpl\$JULWrapper#log
           </argLine>
         </configuration>
       </plugin>
@@ -38,17 +37,17 @@
     <dependency>
       <groupId>org.jvoicexml</groupId>
       <artifactId>javax.speech</artifactId>
-      <version>0.6.10</version>
+      <version>0.6.11</version>
     </dependency>
     <dependency>
       <groupId>org.jvoicexml</groupId>
       <artifactId>org.jvoicexml.jsapi2</artifactId>
-      <version>0.6.10</version>
+      <version>0.6.11</version>
     </dependency>
     <dependency>
       <groupId>org.jvoicexml</groupId>
       <artifactId>org.jvoicexml.jsapi2.freetts</artifactId>
-      <version>0.6.10</version>
+      <version>0.6.11</version>
       <exclusions>
         <exclusion>
           <groupId>com.github.umjammer</groupId>

org.jvoicexml.jsapi2.demo.helloworld/src/test/resources/logging.properties

@@ -3,4 +3,6 @@ handlers=java.util.logging.ConsoleHandler
 java.util.logging.ConsoleHandler.level=ALL
 java.util.logging.ConsoleHandler.formatter=vavi.util.logging.VaviFormatter
 
+vavi.util.logging.VaviFormatter.extraClassMethod=sun\.util\.logging\.internal\.LoggingProviderImpl\$JULWrapper#log
+
 org.jvoicexml.jsapi2.level=ALL

org.jvoicexml.jsapi2.demo.input/pom.xml

@@ -6,7 +6,7 @@
   <parent>
     <groupId>org.jvoicexml</groupId>
     <artifactId>jsapi2</artifactId>
-    <version>0.6.10</version>
+    <version>0.6.11</version>
   </parent>
 
   <artifactId>org.jvoicexml.jsapi2.demo.input</artifactId>
@@ -37,22 +37,22 @@
     <dependency>
       <groupId>org.jvoicexml</groupId>
       <artifactId>javax.speech</artifactId>
-      <version>0.6.10</version>
+      <version>0.6.11</version>
     </dependency>
     <dependency>
       <groupId>org.jvoicexml</groupId>
       <artifactId>org.jvoicexml.jsapi2</artifactId>
-      <version>0.6.10</version>
+      <version>0.6.11</version>
     </dependency>
     <dependency>
       <groupId>org.jvoicexml</groupId>
       <artifactId>org.jvoicexml.jsapi2.freetts</artifactId>
-      <version>0.6.10</version>
+      <version>0.6.11</version>
     </dependency>
     <dependency>
       <groupId>org.jvoicexml</groupId>
       <artifactId>org.jvoicexml.jsapi2.sphinx4</artifactId>
-      <version>0.6.10</version>
+      <version>0.6.11</version>
     </dependency>
 
     <dependency>

org.jvoicexml.jsapi2.demo.rtp/pom.xml

@@ -6,7 +6,7 @@
   <parent>
     <groupId>org.jvoicexml</groupId>
     <artifactId>jsapi2</artifactId>
-    <version>0.6.10</version>
+    <version>0.6.11</version>
   </parent>
 
   <artifactId>org.jvoicexml.jsapi2.demo.rtp</artifactId>
@@ -37,17 +37,17 @@
     <dependency>
       <groupId>org.jvoicexml</groupId>
       <artifactId>javax.speech</artifactId>
-      <version>0.6.10</version>
+      <version>0.6.11</version>
     </dependency>
     <dependency>
       <groupId>org.jvoicexml</groupId>
       <artifactId>org.jvoicexml.jsapi2</artifactId>
-      <version>0.6.10</version>
+      <version>0.6.11</version>
     </dependency>
     <dependency>
       <groupId>org.jvoicexml</groupId>
       <artifactId>org.jvoicexml.jsapi2.freetts</artifactId>
-      <version>0.6.10</version>
+      <version>0.6.11</version>
     </dependency>
 
     <dependency>

org.jvoicexml.jsapi2.freetts/pom.xml

@@ -6,7 +6,7 @@
   <parent>
     <groupId>org.jvoicexml</groupId>
     <artifactId>jsapi2</artifactId>
-    <version>0.6.10</version>
+    <version>0.6.11</version>
   </parent>
 
   <artifactId>org.jvoicexml.jsapi2.freetts</artifactId>
@@ -20,7 +20,6 @@
           <trimStackTrace>false</trimStackTrace>
           <argLine>
             -Djava.util.logging.config.file=${project.build.testOutputDirectory}/logging.properties
-            -Dvavi.util.logging.VaviFormatter.extraClassMethod=sun\.util\.logging\.internal\.LoggingProviderImpl\$JULWrapper#log
           </argLine>
         </configuration>
       </plugin>
@@ -38,13 +37,13 @@
     <dependency>
       <groupId>org.mozilla</groupId>
       <artifactId>rhino</artifactId>
-      <version>1.7.14</version>
+      <scope>runtime</scope>
     </dependency>
 
     <dependency>
       <groupId>org.jvoicexml</groupId>
       <artifactId>org.jvoicexml.jsapi2</artifactId>
-      <version>0.6.10</version>
+      <version>0.6.11</version>
     </dependency>
     <dependency>
       <groupId>${freetts.groupId}</groupId>

org.jvoicexml.jsapi2.freetts/src/test/resources/logging.properties

@@ -3,6 +3,8 @@ handlers=java.util.logging.ConsoleHandler
 java.util.logging.ConsoleHandler.level=ALL
 java.util.logging.ConsoleHandler.formatter=vavi.util.logging.VaviFormatter
 
+vavi.util.logging.VaviFormatter.extraClassMethod=sun\.util\.logging\.internal\.LoggingProviderImpl\$JULWrapper#log
+
 org.jvoicexml.jsapi2.level=ALL
 javax.speech.level=ALL
 #vavi.util.level=WARNING

org.jvoicexml.jsapi2.mac/pom.xml

@@ -20,7 +20,6 @@
           <reuseForks>true</reuseForks>
           <argLine>
             -Djava.util.logging.config.file=${project.build.testOutputDirectory}/logging.properties
-            -Dvavi.util.logging.VaviFormatter.extraClassMethod=sun\\.util\\.logging\\.internal\\.LoggingProviderImpl\\$JULWrapper#log
           </argLine>
         </configuration>
       </plugin>
@@ -38,7 +37,7 @@
     <dependency>
       <groupId>org.mozilla</groupId>
       <artifactId>rhino</artifactId>
-      <version>1.7.14</version>
+      <scope>runtime</scope>
     </dependency>
     <dependency>
       <groupId>org.jvoicexml</groupId>
@@ -53,7 +52,7 @@
     <dependency>
       <groupId>com.github.umjammer.rococoa</groupId>
       <artifactId>rococoa-contrib</artifactId>
-      <version>0.8.7</version>
+      <version>0.8.13</version>
     </dependency>
 
     <dependency>