Fix Java 8 compatibility issues (#313)

sbabcoc · web-flow · commit 74a402754d10 · 2025-11-13T21:36:50.000-08:00
diff --git a/docs/JavaScriptEnhancements.md b/docs/JavaScriptEnhancements.md
@@ -33,6 +33,7 @@ Within the script, use **`document`** to refer to the current document. Note tha
 import org.openqa.selenium.WebDriver;
 import org.openqa.selenium.WebElement;
 import com.nordstrom.automation.selenium.core.JsUtility;
+import com.nordstrom.automation.selenium.core.WebDriverUtils;
  
 public class JavaScriptExample {
  
@@ -50,7 +51,7 @@ public class JavaScriptExample {
         // Execute script as anonymous function, passing specified argument
         WebElement response = JsUtility.runAndReturn(driver, script, "viewport");
         // If element reference was returned, extract 'content' attribute
-        return (response == null) ? null : response.getDomAttribute("content");
+        return (response == null) ? null : WebDriverUtils.getDomAttributeOf(response, "content");
     }
 }
 ```
@@ -88,6 +89,7 @@ import org.openqa.selenium.WebDriver;
 import org.openqa.selenium.WebDriverException;
 import org.openqa.selenium.WebElement;
 import com.nordstrom.automation.selenium.core.JsUtility;
+import com.nordstrom.automation.selenium.core.WebDriverUtils;
  
 public class AnotherJavaScriptExample {
  
@@ -109,7 +111,7 @@ public class AnotherJavaScriptExample {
             // Execute script as anonymous function, passing specified argument
             WebElement response = JsUtility.runAndReturn(driver, script, name);
             // Extract 'content' attribute
-            return response.getDomAttribute("content");
+            return WebDriverUtils.getDomAttributeOf(response, "content");
         } catch (WebDriverException e) {
             // Extract encoded exception
             throw JsUtility.propagate(e);
diff --git a/docs/example/TableComponent.md b/docs/example/TableComponent.md
@@ -13,6 +13,8 @@ import org.openqa.selenium.By;
 import org.openqa.selenium.SearchContext;
 import org.openqa.selenium.WebElement;
 
+import com.nordstrom.automation.selenium.core.WebDriverUtils;
+
 public class TableComponent extends PageComponent {
 
     public TableComponent(By locator, ComponentContainer parent) {
@@ -69,7 +71,7 @@ public class TableComponent extends PageComponent {
     }
     
     public static Object getKey(SearchContext context) {
-        return ((WebElement) context).getDomAttribute("id");
+        return WebDriverUtils.getDomAttributeOf((WebElement) context, "id");
     }
 }
 ```
diff --git a/src/main/java/com/nordstrom/automation/selenium/examples/TextEditApplication.java b/src/main/java/com/nordstrom/automation/selenium/examples/TextEditApplication.java
@@ -1,6 +1,7 @@
 package com.nordstrom.automation.selenium.examples;
 
-import java.util.List;
+import static com.nordstrom.automation.selenium.utility.KeysPayloadBuilder.CMD;
+
 import java.util.Map;
 import java.util.Set;
 import java.util.stream.Collectors;
@@ -10,10 +11,12 @@
 import org.openqa.selenium.TimeoutException;
 import org.openqa.selenium.WebDriver;
 import com.nordstrom.automation.selenium.core.JsUtility;
+import com.nordstrom.automation.selenium.core.WebDriverUtils;
 import com.nordstrom.automation.selenium.exceptions.NoDocumentAppearedTimeoutException;
 import com.nordstrom.automation.selenium.model.Page;
 import com.nordstrom.automation.selenium.model.PageComponent;
 import com.nordstrom.automation.selenium.support.Coordinator;
+import com.nordstrom.automation.selenium.utility.KeysPayloadBuilder;
 
 /**
  * This class is the model for the <b>TextEdit</b> application.
@@ -29,12 +32,15 @@ public TextEditApplication(WebDriver driver) {
 		super(driver);
 	}
 	
-	private static final String DOC_WINDOW_TEMPLATE = ".//XCUIElementTypeWindow[@title='%s']";
+	static {
+		KeysPayloadBuilder.Builder builder = KeysPayloadBuilder.builder();
+		CMD_N = builder.key("n", CMD).build();
+		CMD_O = builder.key("o", CMD).build();
+	}
 	
-	private static final Map<String, Object> CMD_N = 
-			Map.of("keys", List.of(Map.of("key", "n", "modifierFlags", 1 << 4)));
-	private static final Map<String, Object> CMD_O = 
-			Map.of("keys", List.of(Map.of("key", "o", "modifierFlags", 1 << 4)));
+	private static final Map<String, Object> CMD_N;
+	private static final Map<String, Object> CMD_O;
+	private static final String DOC_WINDOW_TEMPLATE = ".//XCUIElementTypeWindow[@title='%s']";
 	
 	private TextEditManagementPanel managementPanel;
 	
@@ -90,7 +96,7 @@ public TextEditDocumentWindow openNewDocument() {
      */
     public Set<String> getOpenDocumentNames() {
 		return driver.findElements(Using.DOCUMENT_WINDOW.locator).stream()
-				.map(e -> e.getDomAttribute("title")).collect(Collectors.toSet());
+				.map(e -> WebDriverUtils.getDomAttributeOf(e, "title")).collect(Collectors.toSet());
     }
     
     /**
@@ -118,9 +124,8 @@ public PageComponent apply(final SearchContext context) {
                     return null;
                 } else {
                 	String name = currentNames.iterator().next();
-                	String xpath = DOC_WINDOW_TEMPLATE.formatted(name);
-                	By locator = By.xpath(xpath);
-                	return new TextEditDocumentWindow(locator, application);
+                	String xpath = String.format(DOC_WINDOW_TEMPLATE, name);
+                	return new TextEditDocumentWindow(By.xpath(xpath), application);
                 }
             }
             
diff --git a/src/main/java/com/nordstrom/automation/selenium/examples/TextEditDocumentWindow.java b/src/main/java/com/nordstrom/automation/selenium/examples/TextEditDocumentWindow.java
@@ -1,6 +1,8 @@
 package com.nordstrom.automation.selenium.examples;
 
 import org.openqa.selenium.By;
+
+import com.nordstrom.automation.selenium.core.WebDriverUtils;
 import com.nordstrom.automation.selenium.model.ComponentContainer;
 import com.nordstrom.automation.selenium.model.PageComponent;
 
@@ -48,7 +50,7 @@ public By locator() {
      * @return document window title
      */
     public String getDocumentTitle() {
-    	return getWrappedElement().getDomAttribute("title");
+    	return WebDriverUtils.getDomAttributeOf(getWrappedElement(), "title");
     }
     
     /**
diff --git a/src/main/java/com/nordstrom/automation/selenium/utility/KeysPayloadBuilder.java b/src/main/java/com/nordstrom/automation/selenium/utility/KeysPayloadBuilder.java
@@ -0,0 +1,88 @@
+package com.nordstrom.automation.selenium.utility;
+
+import java.util.ArrayList;
+import java.util.Arrays;
+import java.util.Collections;
+import java.util.HashMap;
+import java.util.List;
+import java.util.Map;
+import java.util.stream.Collectors;
+
+/**
+ * This utility class facilitates easy assembly lists of key chords for the {@code macos: keys} script
+ * of Appium's <b>Mac2</b> engine.
+ */
+public final class KeysPayloadBuilder {
+
+	/**
+	 * Private constructor to prevent instantiation.
+	 */
+	private KeysPayloadBuilder() {
+		throw new AssertionError("KeysPayloadBuilder is a static utility class that cannot be instantiated");
+	}
+
+	/** SHIFT modifier */
+	public static final int SHIFT = 1 << 1;
+	/** CONTROL modifier */
+	public static final int CTRL = 1 << 2;
+	/** OPTION modifier */
+	public static final int OPT = 1 << 3;
+	/** COMMAND modifier */
+	public static final int CMD = 1 << 4;
+
+	/**
+	 * Return an instance of the <b>Builder</b> class.
+	 * 
+	 * @return new {@link Builder} object
+	 */
+	public static Builder builder() {
+		return new Builder();
+	}
+
+	/**
+	 * This class implements a builder for lists of key chords for the {@code macos: keys} script.
+	 */
+	public static final class Builder {
+		private final List<Map<String, Object>> keys = new ArrayList<>();
+
+		/**
+		 * Add new key chord with modifiers.
+		 * 
+		 * @param k keystroke character
+		 * @param flags modifier flags (may be omitted)
+		 * @return this {@link Builder} object
+		 * @see KeysPayloadBuilder#SHIFT
+		 * @see KeysPayloadBuilder#CTRL
+		 * @see KeysPayloadBuilder#OPT
+		 * @see KeysPayloadBuilder#CMD
+		 */
+		public Builder key(String k, int... flags) {
+			Map<String, Object> m = new HashMap<>();
+			m.put("key", k);
+			
+		    if (flags != null && flags.length > 0) {
+		        int combined = Arrays.stream(flags).reduce(0, (a, b) -> a | b);
+		        m.put("modifierFlags", combined);
+		    }
+
+			keys.add(m);
+			return this;
+		}
+
+		/**
+		 * Assemble payload for the {@code macos: keys} script.
+		 * 
+		 * @return unmodifiable list of key chords for the {@code macos: keys} script
+		 */
+		public Map<String, Object> build() {
+			Map<String, Object> map = Collections.unmodifiableMap(
+				Collections.singletonMap(
+					"keys", 
+					keys.stream()
+						.map(Collections::unmodifiableMap)
+						.collect(Collectors.collectingAndThen(Collectors.toList(), Collections::unmodifiableList))));
+			keys.clear();
+			return map;
+		}
+	}
+}

Original file line number	Diff line number	Diff line change
`@@ -13,6 +13,8 @@ import org.openqa.selenium.By;`
`13`	`13`	`import org.openqa.selenium.SearchContext;`
`14`	`14`	`import org.openqa.selenium.WebElement;`
`15`	`15`
	`16`	`+import com.nordstrom.automation.selenium.core.WebDriverUtils;`
	`17`	`+`
`16`	`18`	`public class TableComponent extends PageComponent {`
`17`	`19`
`18`	`20`	`public TableComponent(By locator, ComponentContainer parent) {`
`@@ -69,7 +71,7 @@ public class TableComponent extends PageComponent {`
`69`	`71`	`}`
`70`	`72`
`71`	`73`	`public static Object getKey(SearchContext context) {`
`72`		`- return ((WebElement) context).getDomAttribute("id");`
	`74`	`+ return WebDriverUtils.getDomAttributeOf((WebElement) context, "id");`
`73`	`75`	`}`
`74`	`76`	`}`
`75`	`77`	```