Skip to content
This repository has been archived by the owner on Apr 30, 2022. It is now read-only.

Commit

Permalink
javadoc warnings breaking build
Browse files Browse the repository at this point in the history
  • Loading branch information
@jason-edstrom
jason-edstrom committed Feb 22, 2020
1 parent 03403a9 commit caba2a9
Show file tree
Hide file tree
Showing 7 changed files with 641 additions and 729 deletions.
22 changes: 9 additions & 13 deletions Framework/jmaqs-selenium/src/main/java/com/magenic/jmaqs/selenium/SeleniumDriverManager.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -21,10 +21,11 @@
public class SeleniumDriverManager extends DriverManager {

/**
* Initializes a new instance of the <see cref="SeleniumDriverManager"/> class.
* Instantiates a new Selenium driver manager.
*
* @param getDriver Function for getting an Selenium web driver
* @param testObject The associated test object
* @param getDriver the get driver
* @param testObject the test object
* @param <T> the type generic
*/
public <T> SeleniumDriverManager(Supplier<T> getDriver, BaseTestObject testObject) {
super(getDriver, testObject);
Expand Down Expand Up @@ -52,9 +53,9 @@ public void close() {
}

/**
* Get the web driver.
* Gets web driver.
*
* @return The web driver
* @return the web driver
*/
public WebDriver getWebDriver() {

Expand All @@ -72,10 +73,10 @@ public WebDriver getWebDriver() {
}

/**
* Log a verbose message and include the automation specific call stack data.
* Log verbose.
*
* @param message The message text
* @param args String format arguments
* @param message the message
* @param args the args
*/
protected void logVerbose(String message, Object... args) {

Expand All @@ -97,11 +98,6 @@ protected void logVerbose(String message, Object... args) {
System.out.println(messages);
}

/**
* Logging startup.
*
* @param webDriver the web driver
*/
private void loggingStartup(WebDriver webDriver) {
try {
WebDriver driver = ((EventFiringWebDriver) webDriver).getWrappedDriver();
Expand Down
81 changes: 26 additions & 55 deletions Framework/jmaqs-selenium/src/main/java/com/magenic/jmaqs/selenium/SeleniumUtilities.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -27,18 +27,12 @@
import org.openqa.selenium.support.events.EventFiringWebDriver;

/**
* Static class for the selenium utilities, ported from MAQS.
* The type Selenium utilities.
*/
public class SeleniumUtilities {

/**
* Default Date Time Format for appending to files.
*/
private static final String DEFAULT_DATE_TIME_FORMAT = "uuuu-MM-dd-HH-mm-ss-SSSS";

/**
* The constant LOG_MESSAGE_PREFIX.
*/
private static final String LOG_MESSAGE_PREFIX = "%s - %s%s";

private SeleniumUtilities() {
Expand All @@ -56,12 +50,12 @@ public static boolean captureScreenshot(WebDriver webDriver, SeleniumTestObject
}

/**
* To capture a screenshot during execution.
* Capture screenshot boolean.
*
* @param webDriver The WebDriver
* @param webDriver the web driver
* @param testObject the test object
* @param appendName Appends a name to the end of a filename
* @return Boolean if the save of the image was successful
* @param appendName the append name
* @return the boolean
*/
public static boolean captureScreenshot(WebDriver webDriver, SeleniumTestObject testObject,
String appendName) {
Expand Down Expand Up @@ -89,14 +83,13 @@ public static boolean captureScreenshot(WebDriver webDriver, SeleniumTestObject
}

/**
* To capture a screenshot during execution.
* Capture screenshot string.
*
* @param webDriver The WebDriver
* @param webDriver the web driver
* @param testObject the test object
* @param directory The directory file path
* @param fileNameWithoutExtension Filename without extension
* @return Path to the log file
* @throws IOException There was a problem creating the screen shot
* @param directory the directory
* @param fileNameWithoutExtension the file name without extension
* @return the string
*/
public static String captureScreenshot(WebDriver webDriver, SeleniumTestObject testObject,
String directory, String fileNameWithoutExtension) {
Expand All @@ -118,36 +111,28 @@ public static String captureScreenshot(WebDriver webDriver, SeleniumTestObject t
return path;
}

/**
* Copy file.
*
* @param tempFile the temp file
* @param path the path
* @throws IOException the io exception
*/
private static void copyFileToPath(File tempFile, String path) throws IOException {
Files.copy(tempFile.toPath(), new File(path).toPath(), StandardCopyOption.COPY_ATTRIBUTES);
}

/**
* To capture a page source during execution.
* Default parameter appendName of empty string.
* Save page source boolean.
*
* @param webDriver the web driver
* @param testObject The Appium Test Object
* @return True if saving page source is successful, otherwise false
* @param testObject the test object
* @return the boolean
*/
public static boolean savePageSource(WebDriver webDriver, SeleniumTestObject testObject) {
return savePageSource(webDriver, testObject, "");
}

/**
* To capture a page source during execution.
* Save page source boolean.
*
* @param webDriver the web driver
* @param testObject The Appium Test Object
* @param appendName Appends a name to the end of a filename
* @return True if saving page source is successful, otherwise false
* @param testObject the test object
* @param appendName the append name
* @return the boolean
*/
public static boolean savePageSource(WebDriver webDriver, SeleniumTestObject testObject,
String appendName) {
Expand Down Expand Up @@ -182,13 +167,13 @@ public static boolean savePageSource(WebDriver webDriver, SeleniumTestObject tes
}

/**
* To capture Page Source during execution.
* Save page source string.
*
* @param webDriver the web driver
* @param testObject The Appium Test Object
* @param directory The directory file path
* @param fileNameWithoutExtension File Name Without Extension
* @return Path to the log file
* @param testObject the test object
* @param directory the directory
* @param fileNameWithoutExtension the file name without extension
* @return the string
*/
public static String savePageSource(WebDriver webDriver, SeleniumTestObject testObject,
String directory, String fileNameWithoutExtension) {
Expand All @@ -214,25 +199,11 @@ public static String savePageSource(WebDriver webDriver, SeleniumTestObject test
return path;
}

/**
* Calculate file name string.
*
* @param directory the directory
* @param fileNameWithoutExtension the file name without extension
* @param fileExtension the file extension
* @return the string
*/
private static String calculateFileName(String directory, String fileNameWithoutExtension,
String fileExtension) {
return Paths.get(directory, fileNameWithoutExtension + fileExtension).normalize().toString();
}

/**
* Validate directory structure and create if it does not exist.
*
* @param testObject the test object
* @param directory the directory
*/
private static void validateDirectoryStructure(SeleniumTestObject testObject, String directory) {
try {
Path path = new File(directory).toPath();
Expand All @@ -246,10 +217,10 @@ private static void validateDirectoryStructure(SeleniumTestObject testObject, St
}

/**
* Get the web driver from a web element.
* Web element to web driver web driver.
*
* @param webElement The web element
* @return The web driver
* @param webElement the web element
* @return the web driver
*/
public static WebDriver webElementToWebDriver(WebElement webElement) {
WebDriver driver;
Expand All @@ -264,7 +235,7 @@ public static WebDriver webElementToWebDriver(WebElement webElement) {
}

/**
* Make sure the driver is shut down.
* Kill driver.
*
* @param webDriver the web driver
*/
Expand Down
Loading

0 comments on commit caba2a9

Please sign in to comment.