[java] minor code style and typos improvements (#12127)

iampopovich · diemol · web-flow · commit 198f1f2b6b3c · 2023-06-05T12:08:15.000+02:00
* function style for expressions

* inspect and fix typos with spellchecker

* Update DefaultNodeConfig.java

---------

Co-authored-by: Diego Molina &lt;diemol@users.noreply.github.com&gt;
diff --git a/java/src/org/openqa/selenium/By.java b/java/src/org/openqa/selenium/By.java
@@ -101,7 +101,7 @@ public static By className(String className) {
 
   /**
    * Find elements via the driver's underlying W3C Selector engine. If the browser does not
-   * implement the Selector API, a best effort is made to emulate the API. In this case, we strive
+   * implement the Selector API, the best effort is made to emulate the API. In this case, we strive
    * for at least CSS2 support, but offer no guarantees.
    *
    * @param cssSelector CSS expression.
diff --git a/java/src/org/openqa/selenium/Capabilities.java b/java/src/org/openqa/selenium/Capabilities.java
@@ -71,7 +71,7 @@ default String getBrowserVersion() {
 
   /**
    * @param capabilityName The capability to check.
-   * @return Whether or not the value is not null and not false.
+   * @return Whether the value is not null and not false.
    * @see org.openqa.selenium.remote.CapabilityType
    */
   default boolean is(String capabilityName) {
diff --git a/java/src/org/openqa/selenium/grid/distributor/selector/DefaultSlotSelector.java b/java/src/org/openqa/selenium/grid/distributor/selector/DefaultSlotSelector.java
@@ -39,7 +39,7 @@ public Set<SlotId> selectSlot(Capabilities capabilities, Set<NodeStatus> nodes)
     // First, filter the Nodes that support the required capabilities. Then, the filtered Nodes
     // get ordered in ascendant order by the number of browsers they support.
     // With this, Nodes with diverse configurations (supporting many browsers, e.g. Chrome,
-    // Firefox, Safari) are placed at the bottom so they have more availability when a session
+    // Firefox, Safari) are placed at the bottom, so they have more availability when a session
     // requests a browser supported only by a few Nodes (e.g. Safari only supported on macOS
     // Nodes).
     // After that, Nodes are ordered by their load, last session creation, and their id.
diff --git a/java/src/org/openqa/selenium/grid/graphql/SessionNotFoundException.java b/java/src/org/openqa/selenium/grid/graphql/SessionNotFoundException.java
@@ -44,9 +44,7 @@ public SessionNotFoundException(String message, String sessionId) {
   @Override
   public Map<String, Object> getExtensions() {
     Map<String, Object> customAttributes = new LinkedHashMap<>();
-    if (sessionId.isPresent()) {
-      customAttributes.put("sessionId", sessionId.get());
-    }
+    sessionId.ifPresent(s -> customAttributes.put("sessionId", s));
     return customAttributes;
   }
 
diff --git a/java/src/org/openqa/selenium/interactions/Coordinates.java b/java/src/org/openqa/selenium/interactions/Coordinates.java
@@ -52,7 +52,7 @@ public interface Coordinates {
   /**
    * Gets coordinates on the element relative to the top-left corner of the page.
    *
-   * @return coordinates on the element relative to the top-left corner of the the page.
+   * @return coordinates on the element relative to the top-left corner of the page.
    */
   Point onPage();
 
diff --git a/java/src/org/openqa/selenium/internal/Debug.java b/java/src/org/openqa/selenium/internal/Debug.java
@@ -20,7 +20,7 @@
 import java.lang.management.ManagementFactory;
 import java.util.logging.Level;
 
-/** Used to provide information about whether or not Selenium is running under debug mode. */
+/** Used to provide information about whether Selenium is running under debug mode. */
 public class Debug {
 
   private static boolean IS_DEBUG;
diff --git a/java/src/org/openqa/selenium/remote/CommandCodec.java b/java/src/org/openqa/selenium/remote/CommandCodec.java
@@ -23,7 +23,7 @@
 /**
  * Converts {@link Command} objects to and from another representation.
  *
- * @param <T> The type of an encoded command.
+ * @param <T> The type of encoded command.
  */
 public interface CommandCodec<T> {
 
diff --git a/java/src/org/openqa/selenium/remote/codec/AbstractHttpResponseCodec.java b/java/src/org/openqa/selenium/remote/codec/AbstractHttpResponseCodec.java
@@ -48,7 +48,7 @@ public abstract class AbstractHttpResponseCodec implements ResponseCodec<HttpRes
   private final Json json = new Json();
 
   /**
-   * Encodes the given response as a HTTP response message. This method is guaranteed not to throw.
+   * Encodes the given response as an HTTP response message. This method is guaranteed not to throw.
    *
    * @param response The response to encode.
    * @return The encoded response.
diff --git a/java/src/org/openqa/selenium/support/pagefactory/AbstractAnnotations.java b/java/src/org/openqa/selenium/support/pagefactory/AbstractAnnotations.java
@@ -27,15 +27,15 @@
 public abstract class AbstractAnnotations {
 
   /**
-   * Defines how to transform given object (field, class, etc) into {@link org.openqa.selenium.By}
+   * Defines how to transform given object (field, class, etc.) into {@link org.openqa.selenium.By}
    * class used by webdriver to locate elements.
    *
    * @return By object
    */
   public abstract By buildBy();
 
   /**
-   * Defines whether or not given element should be returned from cache on further calls.
+   * Defines whether given element should be returned from cache on further calls.
    *
    * @return boolean if lookup cached
    */
diff --git a/java/src/org/openqa/selenium/support/pagefactory/AjaxElementLocator.java b/java/src/org/openqa/selenium/support/pagefactory/AjaxElementLocator.java
@@ -118,15 +118,15 @@ protected long sleepFor() {
 
   /**
    * By default, elements are considered "found" if they are in the DOM. Override this method in
-   * order to change whether or not you consider the element loaded. For example, perhaps you need
+   * order to change whether you consider the element loaded. For example, perhaps you need
    * the element to be displayed:
    *
    * <pre>{@code
    * return element.isDisplayed();
    * }</pre>
    *
    * @param element The element to use
-   * @return Whether or not it meets your criteria for "found"
+   * @return Whether it meets your criteria for "found"
    */
   protected boolean isElementUsable(WebElement element) {
     return true;
diff --git a/java/src/org/openqa/selenium/support/pagefactory/DefaultFieldDecorator.java b/java/src/org/openqa/selenium/support/pagefactory/DefaultFieldDecorator.java
@@ -33,7 +33,7 @@
 import org.openqa.selenium.support.pagefactory.internal.LocatingElementListHandler;
 
 /**
- * Default decorator for use with PageFactory. Will decorate 1) all of the WebElement fields and 2)
+ * Default decorator for use with PageFactory. Will decorate 1) all the WebElement fields and 2)
  * List&lt;WebElement&gt; fields that have {@literal @FindBy}, {@literal @FindBys}, or
  * {@literal @FindAll} annotation with a proxy that locates the elements using the passed in
  * ElementLocatorFactory.
diff --git a/java/test/org/openqa/selenium/environment/webserver/CookieHandler.java b/java/test/org/openqa/selenium/environment/webserver/CookieHandler.java
@@ -49,7 +49,7 @@ class CookieHandler implements HttpHandler {
   public HttpResponse execute(HttpRequest request) throws UncheckedIOException {
     HttpResponse response = new HttpResponse();
     response.setHeader("Content-Type", "text/html");
-    // Dont Cache Anything  at the browser
+    // Don't Cache Anything  at the browser
     response.setHeader("Cache-Control", "no-cache");
     response.setHeader("Pragma", "no-cache");
     response.setHeader("Expires", EPOCH_START);
diff --git a/java/test/org/openqa/selenium/grid/node/local/CreateSessionTest.java b/java/test/org/openqa/selenium/grid/node/local/CreateSessionTest.java
@@ -84,7 +84,7 @@ void shouldAcceptAW3CPayload() throws URISyntaxException {
           json.toType(new String(sessionResponse.getDownstreamEncodedResponse(), UTF_8), MAP_TYPE);
 
       // Ensure that there's no status field (as this is used by the protocol handshake to determine
-      // whether the session is using the JWP or the W3C dialect.
+      // whether the session is using the JWP or the W3C dialect).
       assertThat(all.containsKey("status")).isFalse();
 
       // Now check the fields required by the spec
@@ -140,7 +140,7 @@ void shouldPreferUsingTheW3CProtocol() throws URISyntaxException {
           json.toType(new String(sessionResponse.getDownstreamEncodedResponse(), UTF_8), MAP_TYPE);
 
       // Ensure that there's no status field (as this is used by the protocol handshake to determine
-      // whether the session is using the JWP or the W3C dialect.
+      // whether the session is using the JWP or the W3C dialect).
       assertThat(all.containsKey("status")).isFalse();
 
       // Now check the fields required by the spec
diff --git a/java/test/org/openqa/selenium/support/pagefactory/AjaxElementLocatorTest.java b/java/test/org/openqa/selenium/support/pagefactory/AjaxElementLocatorTest.java
@@ -94,7 +94,7 @@ void shouldThrowNoSuchElementExceptionIfElementTakesTooLongToAppear() throws Exc
 
     assertThatExceptionOfType(NoSuchElementException.class).isThrownBy(locator::findElement);
 
-    // Look ups:
+    // Look-ups:
     // 1. In "isLoaded"
     // 2. Immediately after call of load. (clock is 0)
     // 3. First sleep, then third call.   (clock is 1)
diff --git a/java/test/org/openqa/selenium/testing/SeleniumExtension.java b/java/test/org/openqa/selenium/testing/SeleniumExtension.java
@@ -140,8 +140,8 @@ public void afterEach(ExtensionContext context) throws Exception {
       throw new Exception(
           String.format(
               "%s.%s is marked as not yet implemented with %s but already works!",
-              testClass.isPresent() ? testClass.get().getName() : "",
-              testMethod.isPresent() ? testMethod.get().getName() : "",
+              testClass.map(Class::getName).orElse(""),
+              testMethod.map(Method::getName).orElse(""),
               current));
     }
   }

Original file line number	Diff line number	Diff line change
`@@ -101,7 +101,7 @@ public static By className(String className) {`
`101`	`101`
`102`	`102`	`/**`
`103`	`103`	`* Find elements via the driver's underlying W3C Selector engine. If the browser does not`
`104`		`- * implement the Selector API, a best effort is made to emulate the API. In this case, we strive`
	`104`	`+ * implement the Selector API, the best effort is made to emulate the API. In this case, we strive`
`105`	`105`	`* for at least CSS2 support, but offer no guarantees.`
`106`	`106`	`*`
`107`	`107`	`* @param cssSelector CSS expression.`
Original file line number	Diff line number	Diff line change
`@@ -52,7 +52,7 @@ public interface Coordinates {`
`52`	`52`	`/**`
`53`	`53`	`* Gets coordinates on the element relative to the top-left corner of the page.`
`54`	`54`	`*`
`55`		`- * @return coordinates on the element relative to the top-left corner of the the page.`
	`55`	`+ * @return coordinates on the element relative to the top-left corner of the page.`
`56`	`56`	`*/`
`57`	`57`	`Point onPage();`
`58`	`58`
Original file line number	Diff line number	Diff line change
`@@ -23,7 +23,7 @@`
`23`	`23`	`/**`
`24`	`24`	`* Converts {@link Command} objects to and from another representation.`
`25`	`25`	`*`
`26`		`- * @param <T> The type of an encoded command.`
	`26`	`+ * @param <T> The type of encoded command.`
`27`	`27`	`*/`
`28`	`28`	`public interface CommandCodec<T> {`
`29`	`29`
Original file line number	Diff line number	Diff line change
`@@ -48,7 +48,7 @@ public abstract class AbstractHttpResponseCodec implements ResponseCodec<HttpRes`
`48`	`48`	`private final Json json = new Json();`
`49`	`49`
`50`	`50`	`/**`
`51`		`- * Encodes the given response as a HTTP response message. This method is guaranteed not to throw.`
	`51`	`+ * Encodes the given response as an HTTP response message. This method is guaranteed not to throw.`
`52`	`52`	`*`
`53`	`53`	`* @param response The response to encode.`
`54`	`54`	`* @return The encoded response.`