refactor: update javadoc and code style

Author: germanattanasio

assistant/src/test/java/com/ibm/watson/assistant/v1/AssistantServiceIT.java

@@ -104,6 +104,11 @@ public class AssistantServiceIT extends AssistantServiceTest {
 
   private DateFormat isoDateFormat = new SimpleDateFormat("yyyy-MM-dd'T'HH:mm:ss.SSSX");
 
+  /**
+   * Sets the up.
+   *
+   * @throws Exception the exception
+   */
   @Override
   @Before
   public void setUp() throws Exception {
@@ -122,7 +127,11 @@ public void testReadme() {
     System.out.println(response);
   }
 
-  /** Test Example. */
+  /**
+   * Test Example.
+   *
+   * @throws InterruptedException the interrupted exception
+   */
   @Test
   public void testExample() throws InterruptedException {
     MessageInput input = new MessageInput();
@@ -163,6 +172,7 @@ public void accept(Response<MessageResponse> response) throws Exception {
     Thread.sleep(5000);
   }
 
+  /** Ping bad credentials throws exception. */
   @Test(expected = ForbiddenException.class)
   public void pingBadCredentialsThrowsException() {
     Assistant badService = new Assistant("2019-02-28", new BasicAuthenticator("foo", "bar"));
@@ -482,6 +492,7 @@ public void testUpdateCounterexample() {
     }
   }
 
+  /** Creates the example intent. */
   public void createExampleIntent() {
     exampleIntent = "Hello";
     try {
@@ -1809,6 +1820,7 @@ public void testDeleteUserData() {
     }
   }
 
+  /** Test list mentions. */
   @Test
   public void testListMentions() {
     String entity = "amenity";

assistant/src/test/java/com/ibm/watson/assistant/v1/AssistantServiceTest.java

@@ -19,19 +19,35 @@
 import org.junit.Assume;
 import org.junit.Before;
 
+/** The Class AssistantServiceTest. */
 public class AssistantServiceTest extends WatsonServiceTest {
 
   private Assistant service;
   private String workspaceId;
 
+  /**
+   * Gets the service.
+   *
+   * @return the service
+   */
   public Assistant getService() {
     return this.service;
   }
 
+  /**
+   * Gets the workspace id.
+   *
+   * @return the workspace id
+   */
   public String getWorkspaceId() {
     return this.workspaceId;
   }
 
+  /**
+   * Sets the up.
+   *
+   * @throws Exception the exception
+   */
   /*
    * (non-Javadoc)
    * @see com.ibm.watson.common.WatsonServiceTest#setUp()
@@ -53,12 +69,24 @@ public void setUp() throws Exception {
 
   private long tolerance = 2000; // 2 secs in ms
 
-  /** return `true` if ldate before rdate within tolerance. */
+  /**
+   * return `true` if ldate before rdate within tolerance.
+   *
+   * @param ldate the ldate
+   * @param rdate the rdate
+   * @return true, if successful
+   */
   public boolean fuzzyBefore(Date ldate, Date rdate) {
     return (ldate.getTime() - rdate.getTime()) < tolerance;
   }
 
-  /** return `true` if ldate after rdate within tolerance. */
+  /**
+   * return `true` if ldate after rdate within tolerance.
+   *
+   * @param ldate the ldate
+   * @param rdate the rdate
+   * @return true, if successful
+   */
   public boolean fuzzyAfter(Date ldate, Date rdate) {
     return (rdate.getTime() - ldate.getTime()) < tolerance;
   }

assistant/src/test/java/com/ibm/watson/assistant/v1/AssistantTest.java

@@ -99,6 +99,11 @@ public class AssistantTest extends WatsonServiceUnitTest {
   private static final String PATH_MESSAGE = "/v1/workspaces/" + WORKSPACE_ID + "/message";
   private static final String VERSION = "version";
 
+  /**
+   * Sets the up.
+   *
+   * @throws Exception the exception
+   */
   /*
    * (non-Javadoc)
    * @see com.ibm.watson.common.WatsonServiceTest#setUp()
@@ -242,6 +247,12 @@ public void testSendMessageWithAlternateIntents() throws IOException, Interrupte
     assertEquals(request.getMethod(), "POST");
   }
 
+  /**
+   * Test send message with message request.
+   *
+   * @throws FileNotFoundException the file not found exception
+   * @throws InterruptedException the interrupted exception
+   */
   @Test
   public void testSendMessageWithMessageRequest()
       throws FileNotFoundException, InterruptedException {
@@ -638,6 +649,7 @@ public void testUpdateWorkspaceOptionsBuilder() {
     assertEquals(options2.dialogNodes().get(0), testDialogNode2);
   }
 
+  /** Test get workspace options builder. */
   @Test
   public void testGetWorkspaceOptionsBuilder() {
     String workspaceId = "workspace_id";
@@ -658,6 +670,7 @@ public void testGetWorkspaceOptionsBuilder() {
     assertEquals(sort, getWorkspaceOptions.sort());
   }
 
+  /** Test create example options builder. */
   @Test
   public void testCreateExampleOptionsBuilder() {
     Mention mentions1 = new Mention.Builder().entity(ENTITY).location(LOCATION).build();
@@ -682,6 +695,7 @@ public void testCreateExampleOptionsBuilder() {
     assertEquals(createExampleOptions.intent(), INTENT);
   }
 
+  /** Test update example options builder. */
   @Test
   public void testUpdateExampleOptionsBuilder() {
     Mention mentions1 = new Mention.Builder().entity(ENTITY).location(LOCATION).build();
@@ -1076,6 +1090,7 @@ public void testDeleteUserDataOptionsBuilder() {
     assertEquals(deleteOptions.customerId(), customerId);
   }
 
+  /** Test list mentions builder. */
   @Test
   public void testListMentionsBuilder() {
     String entity = "entity";
@@ -1094,6 +1109,7 @@ public void testListMentionsBuilder() {
     assertEquals(listMentionsOptions.includeAudit(), true);
   }
 
+  /** Test message context metadata. */
   @Test
   public void testMessageContextMetadata() {
     String deployment = "deployment";
@@ -1106,6 +1122,7 @@ public void testMessageContextMetadata() {
     assertEquals(userId, messageContextMetadata.userId());
   }
 
+  /** Test create entity builder. */
   @Test
   public void testCreateEntityBuilder() {
     String entity = "entity";
@@ -1145,6 +1162,7 @@ public void testCreateEntityBuilder() {
     assertEquals(testDate, createEntity.updated());
   }
 
+  /** Test create intent builder. */
   @Test
   public void testCreateIntentBuilder() {
     String intent = "intent";

assistant/src/test/java/com/ibm/watson/assistant/v1/EntitiesIT.java

@@ -40,12 +40,18 @@
 import org.junit.Test;
 import org.junit.runner.RunWith;
 
+/** The Class EntitiesIT. */
 @RunWith(RetryRunner.class)
 public class EntitiesIT extends AssistantServiceTest {
 
   private Assistant service;
   private String workspaceId;
 
+  /**
+   * Sets the up.
+   *
+   * @throws Exception the exception
+   */
   @Override
   @Before
   public void setUp() throws Exception {

assistant/src/test/java/com/ibm/watson/assistant/v1/SynonymsIT.java

@@ -34,12 +34,18 @@
 import org.junit.Test;
 import org.junit.runner.RunWith;
 
+/** The Class SynonymsIT. */
 @RunWith(RetryRunner.class)
 public class SynonymsIT extends AssistantServiceTest {
 
   private Assistant service;
   private String workspaceId;
 
+  /**
+   * Sets the up.
+   *
+   * @throws Exception the exception
+   */
   @Override
   @Before
   public void setUp() throws Exception {
@@ -363,7 +369,9 @@ public void testListSynonymsWithPaging() {
       assertNotNull(response.getPagination().getNextUrl());
       assertNotNull(response.getPagination().getNextCursor());
 
-      boolean found1 = false, found2 = false;
+      boolean found1 = false;
+      boolean found2 = false;
+
       while (true) {
         assertNotNull(response.getSynonyms());
         assertTrue(response.getSynonyms().size() == 1);

assistant/src/test/java/com/ibm/watson/assistant/v1/ValuesIT.java

@@ -38,12 +38,18 @@
 import org.junit.Test;
 import org.junit.runner.RunWith;
 
+/** The Class ValuesIT. */
 @RunWith(RetryRunner.class)
 public class ValuesIT extends AssistantServiceTest {
 
   private Assistant service;
   private String workspaceId;
 
+  /**
+   * Sets the up.
+   *
+   * @throws Exception the exception
+   */
   @Override
   @Before
   public void setUp() throws Exception {

assistant/src/test/java/com/ibm/watson/assistant/v2/AssistantServiceIT.java

@@ -42,6 +42,11 @@ public class AssistantServiceIT extends AssistantServiceTest {
   private Assistant service;
   private String assistantId;
 
+  /**
+   * Sets the up.
+   *
+   * @throws Exception the exception
+   */
   @Override
   @Before
   public void setUp() throws Exception {
@@ -50,6 +55,7 @@ public void setUp() throws Exception {
     this.assistantId = getAssistantId();
   }
 
+  /** Test send messages. */
   @Test
   public void testSendMessages() {
     // get session ID
@@ -107,6 +113,7 @@ public void testSendMessages() {
     }
   }
 
+  /** Test send message stateless. */
   @Test
   public void testSendMessageStateless() {
     // get session ID

assistant/src/test/java/com/ibm/watson/assistant/v2/AssistantServiceTest.java

@@ -19,19 +19,35 @@
 import org.junit.Assume;
 import org.junit.Before;
 
+/** The Class AssistantServiceTest. */
 public class AssistantServiceTest extends WatsonServiceTest {
 
   private Assistant service;
   private String assistantId;
 
+  /**
+   * Gets the service.
+   *
+   * @return the service
+   */
   public Assistant getService() {
     return this.service;
   }
 
+  /**
+   * Gets the assistant id.
+   *
+   * @return the assistant id
+   */
   public String getAssistantId() {
     return this.assistantId;
   }
 
+  /**
+   * Sets the up.
+   *
+   * @throws Exception the exception
+   */
   /*
    * (non-Javadoc)
    * @see com.ibm.watson.common.WatsonServiceTest#setUp()
@@ -53,12 +69,24 @@ public void setUp() throws Exception {
 
   private long tolerance = 2000; // 2 secs in ms
 
-  /** return `true` if ldate before rdate within tolerance. */
+  /**
+   * return `true` if ldate before rdate within tolerance.
+   *
+   * @param ldate the ldate
+   * @param rdate the rdate
+   * @return true, if successful
+   */
   public boolean fuzzyBefore(Date ldate, Date rdate) {
     return (ldate.getTime() - rdate.getTime()) < tolerance;
   }
 
-  /** return `true` if ldate after rdate within tolerance. */
+  /**
+   * return `true` if ldate after rdate within tolerance.
+   *
+   * @param ldate the ldate
+   * @param rdate the rdate
+   * @return true, if successful
+   */
   public boolean fuzzyAfter(Date ldate, Date rdate) {
     return (rdate.getTime() - ldate.getTime()) < tolerance;
   }