Fix: encoding for examples and javadoc

Author: lasp73

recognizer-examples/pom.xml

@@ -14,8 +14,8 @@
 	<properties>
 		<maven.compiler.source>1.8</maven.compiler.source>
 		<maven.compiler.target>1.8</maven.compiler.target>
+	    <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
 	</properties>
-
 	<dependencies>
 		<dependency>
 			<groupId>br.com.cpqd.asr</groupId>

recognizer/src/main/java/br/com/cpqd/asr/recognizer/SpeechRecognizer.java

@@ -1,12 +1,12 @@
 /*******************************************************************************
  * Copyright 2017 CPqD. All Rights Reserved.
- * 
+ *
  * Licensed under the Apache License, Version 2.0 (the "License"); you may not
  * use this file except in compliance with the License.  You may obtain a copy
  * of the License at
- * 
+ *
  *   http://www.apache.org/licenses/LICENSE-2.0
- * 
+ *
  * Unless required by applicable law or agreed to in writing, software
  * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
  * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  See the
@@ -33,15 +33,15 @@ public interface SpeechRecognizer {
 
 	/**
 	 * Release resources and close the server connection.
-	 * 
+	 *
 	 * @throws IOException
 	 *             some sort of I/O exception has ocurred.
 	 */
 	void close() throws IOException;
 
 	/**
 	 * Cancels the current recognition, closing the audio source.
-	 * 
+	 *
 	 * @throws IOException
 	 *             some sort of I/O exception has ocurred.
 	 * @throws RecognitionException
@@ -54,12 +54,12 @@ public interface SpeechRecognizer {
 	 * be created previously. The recognition result will be notified in the
 	 * registered AsrListener callbacks. The audio source is automatically
 	 * closed after the end of the recognition process.
-	 * 
+	 *
 	 * @param lmList
 	 *            the language model to use.
 	 * @param audio
 	 *            audio source.
-	 * 
+	 *
 	 * @throws IOException
 	 *             some sort of I/O exception has ocurred.
 	 * @throws RecognitionException
@@ -72,14 +72,14 @@ public interface SpeechRecognizer {
 	 * be created previously. The recognition result will be notified in the
 	 * registered AsrListener callbacks. The audio source is automatically
 	 * closed after the end of the recognition process.
-	 * 
+	 *
 	 * @param lmList
 	 *            the language model to use.
 	 * @param audio
 	 *            audio source.
 	 * @param config
 	 *            recognition configuration parameters.
-	 * 
+	 *
 	 * @throws IOException
 	 *             some sort of I/O exception has ocurred.
 	 * @throws RecognitionException
@@ -92,7 +92,7 @@ void recognize(AudioSource audio, LanguageModelList lmList, RecognitionConfig co
 	 * Returns the recognition result. If audio packets are still being sent to
 	 * the server, the method blocks and waits for the end of the recognition
 	 * process.
-	 * 
+	 *
 	 * @return the recognition result or null if there is no result available.
 	 * @throws RecognitionException
 	 *             in case an error in the recognition occurs.
@@ -102,7 +102,7 @@ void recognize(AudioSource audio, LanguageModelList lmList, RecognitionConfig co
 	/**
 	 * Returns the recognition result. If audio packets are still being sent to the
 	 * server, the method blocks and waits for the end of the recognition process.
-	 * 
+	 *
 	 * @param timeout
 	 *            the max wait time for a recognition result (in seconds). The timer
 	 *            is started after the last audio packet is sent.
@@ -114,7 +114,7 @@ void recognize(AudioSource audio, LanguageModelList lmList, RecognitionConfig co
 
 	/**
 	 * Creates a new instance of the object builder.
-	 * 
+	 *
 	 * @return the Builder object.
 	 */
 	static SpeechRecognizer.Builder builder() {
@@ -179,7 +179,7 @@ public class Builder {
 
 		/**
 		 * Private constructor. Defines default configuration parameters.
-		 * 
+		 *
 		 */
 		protected Builder() {
 			this.audioSampleRate = 8000;
@@ -192,7 +192,7 @@ protected Builder() {
 
 		/**
 		 * Builds an SpeechRecognizer instance.
-		 * 
+		 *
 		 * @return the recognizer instance.
 		 * @throws URISyntaxException
 		 *             if there is an error with the server URL parameter.
@@ -208,12 +208,13 @@ public SpeechRecognizer build() throws URISyntaxException, IOException, Recognit
 
 		/**
 		 * Defines the Server URL.
-		 * 
+		 *
 		 * @param url
 		 *            the ASR Server endpoint URL (e.g.:
 		 *            ws://192.168.100.1:8025/asr-server).
 		 * @return the Builder object
-		 * @throws URISyntaxException 
+		 *
+		 * @throws URISyntaxException Invalid URL
 		 */
 		public SpeechRecognizer.Builder serverURL(String url) throws URISyntaxException {
 			this.uri = new URI(url);
@@ -222,7 +223,7 @@ public SpeechRecognizer.Builder serverURL(String url) throws URISyntaxException
 
 		/**
 		 * Sets user access credentials, if required by the server.
-		 * 
+		 *
 		 * @param username
 		 *            user id.
 		 * @param password
@@ -239,7 +240,7 @@ public SpeechRecognizer.Builder credentials(String username, String password) {
 
 		/**
 		 * Configure the recognition parameters.
-		 * 
+		 *
 		 * @param recogConfig
 		 *            the configuration parameters.
 		 * @return the Builder object.
@@ -251,7 +252,7 @@ public SpeechRecognizer.Builder recogConfig(RecognitionConfig recogConfig) {
 
 		/**
 		 * Register a call back listener interface.
-		 * 
+		 *
 		 * @param listener
 		 *            the listener object.
 		 * @return the Builder object.
@@ -264,7 +265,7 @@ public SpeechRecognizer.Builder addListener(RecognitionListener listener) {
 		/**
 		 * Sets the user agent data. This information indicates the
 		 * characteristics of the client for logging and debug purposes.
-		 * 
+		 *
 		 * @param userAgent
 		 *            the user agent data.
 		 * @return the Builder object.
@@ -276,7 +277,7 @@ public SpeechRecognizer.Builder userAgent(String userAgent) {
 
 		/**
 		 * Sets the maximum time the client waits for the recognition result.
-		 * 
+		 *
 		 * @param timeout
 		 *            the timeout value (in seconds).
 		 * @return the Builder object.
@@ -290,7 +291,7 @@ public SpeechRecognizer.Builder maxWaitSeconds(int timeout) {
 		 * Sets the connect on recognize property. If set to true, the ASR
 		 * session is automatically created at each recognition. Otherwise, it
 		 * is created when the SpeechRecognizer is built.
-		 * 
+		 *
 		 * @param connectOnRecognize
 		 *            the connectOnRecognize property value.
 		 * @return the Builder object.
@@ -304,7 +305,7 @@ public SpeechRecognizer.Builder connectOnRecognize(boolean connectOnRecognize) {
 		 * Sets the auto close property. If set to true, the ASR session is
 		 * automatically closed at the end of each recognition. Otherwise, it is
 		 * kept open for the next recognition.
-		 * 
+		 *
 		 * @param autoClose
 		 *            the autoClose property value.
 		 * @return the Builder object.
@@ -316,7 +317,7 @@ public SpeechRecognizer.Builder autoClose(boolean autoClose) {
 
 		/**
 		 * Sets the maximum session idle time.
-		 * 
+		 *
 		 * @param maxSessionIdleSeconds
 		 *            the max session idle time in seconds.
 		 * @return the Builder object.
@@ -328,7 +329,7 @@ public SpeechRecognizer.Builder maxSessionIdleSeconds(int maxSessionIdleSeconds)
 
 		/**
 		 * Sets the audio sample rate (in bps).
-		 * 
+		 *
 		 * @param sampleRate
 		 *            the audio sample rate.
 		 * @return the Builder object.
@@ -341,7 +342,7 @@ private SpeechRecognizer.Builder audioSampleRate(int sampleRate) {
 
 		/**
 		 * Sets the audio encoding.
-		 * 
+		 *
 		 * @param encoding
 		 *            the audio encoding.
 		 * @return the Builder object.
@@ -354,7 +355,7 @@ private SpeechRecognizer.Builder audioEncoding(AudioEncoding encoding) {
 
 		/**
 		 * Sets the audio language.
-		 * 
+		 *
 		 * @param language
 		 *            the audio language.
 		 * @return the Builder object.

recognizer/src/main/java/br/com/cpqd/asr/recognizer/ws/AsrClientEndpoint.java

@@ -1,12 +1,12 @@
 /*******************************************************************************
  * Copyright 2018 CPqD. All Rights Reserved.
- * 
+ *
  * Licensed under the Apache License, Version 2.0 (the "License"); you may not
  * use this file except in compliance with the License.  You may obtain a copy
  * of the License at
- * 
+ *
  *   http://www.apache.org/licenses/LICENSE-2.0
- * 
+ *
  * Unless required by applicable law or agreed to in writing, software
  * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
  * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  See the
@@ -73,7 +73,7 @@
 
 /**
  * Websocket endpoint (JSR 356) for communicating with the ASR server.
- * 
+ *
  */
 @ClientEndpoint(decoders = { AsrProtocolEncoder.class }, encoders = { AsrProtocolEncoder.class })
 public class AsrClientEndpoint {
@@ -102,9 +102,14 @@ public class AsrClientEndpoint {
 
 	/**
 	 * Constructor.
-	 * 
+	 *
 	 * @param uri
 	 *            the websocket server endpoint URI.
+	 * @param username
+	 *            Username to have access to API.
+	 * @param password
+	 *            Password to have access to API.
+	 *
 	 * @throws URISyntaxException
 	 *             invalid server URL (e.g: 'ws://127.0.0.1:8025/asr-server/asr').
 	 */
@@ -161,7 +166,7 @@ public AsrClientEndpoint(URI uri, String username, String password) throws URISy
 
 	/**
 	 * Opens a websocket connection with the server.
-	 * 
+	 *
 	 * @throws IOException
 	 *             some sort of I/O exception has ocurred.
 	 * @throws DeploymentException
@@ -174,7 +179,7 @@ public void open() throws DeploymentException, IOException {
 
 	/**
 	 * Returns the registered listeners for protocol events.
-	 * 
+	 *
 	 * @return the registered listeners.
 	 */
 	public List<RecognitionListener> getListeners() {
@@ -183,7 +188,7 @@ public List<RecognitionListener> getListeners() {
 
 	/**
 	 * Verifies if the server connection is open.
-	 * 
+	 *
 	 * @return true if the connection is open.
 	 */
 	public boolean isOpen() {
@@ -211,7 +216,7 @@ public void close() {
 	/**
 	 * Send a binary message to the server, via websocket connection, and wait for
 	 * the server response.
-	 * 
+	 *
 	 * @param message
 	 *            the protocol message object.
 	 * @return the response message.
@@ -233,7 +238,7 @@ public synchronized ResponseMessage sendMessageAndWait(AsrMessage message) throw
 
 	/**
 	 * Send a binary message to the server, via websocket connection.
-	 * 
+	 *
 	 * @param message
 	 *            the protocol message object.
 	 * @throws IOException
@@ -247,7 +252,7 @@ public synchronized void sendMessage(AsrMessage message) throws IOException, Enc
 
 	/**
 	 * Call back method called when the websocket connection is opened.
-	 * 
+	 *
 	 * @param session
 	 *            the websocket session.
 	 */
@@ -259,7 +264,7 @@ public void onOpen(Session session) {
 
 	/**
 	 * Call back method called when the websocket connection is closed.
-	 * 
+	 *
 	 * @param session
 	 *            the websocket session.
 	 * @param closeReason
@@ -295,7 +300,7 @@ public void onClose(Session session, CloseReason closeReason) {
 
 	/**
 	 * Call back method called when a protocol message is received.
-	 * 
+	 *
 	 * @param message
 	 *            the protocol message.
 	 * @param session
@@ -445,7 +450,7 @@ public void onError(Session session, Throwable thr) {
 
 	/**
 	 * Returns the websocket session id.
-	 * 
+	 *
 	 * @return the websocket session id.
 	 */
 	public String getSessionId() {
@@ -457,7 +462,7 @@ public String getSessionId() {
 
 	/**
 	 * Returns the recognition session status.
-	 * 
+	 *
 	 * @return the recognition session status.
 	 */
 	public SessionStatus getStatus() {