[1.4.2-documentation] - added java docs

dzaiats · dzaiats · commit a4156a2350f6 · 2016-12-11T10:48:34.000+01:00
diff --git a/src/main/java/http/helpers/TextFinder.java b/src/main/java/http/helpers/TextFinder.java
@@ -10,6 +10,13 @@ public class TextFinder {
 
     private static double DERIVATION = 0.3;
 
+    /**
+     * Smart Text finder that allows to fins piece of corrupted text
+     *
+     * @param pattern
+     * @param text
+     * @return
+     */
     public static boolean textIsFound(String pattern, String text) {
         pattern = pattern.toLowerCase();
         text = text.toLowerCase();
@@ -81,10 +88,15 @@ public static boolean textIsFound(String pattern, String text) {
         }
     }
 
-    public static void setDerivation(int derivation){
-        if (derivation > 1){
+    /**
+     * Set derivation for text searching
+     *
+     * @param derivation
+     */
+    public static void setDerivation(int derivation) {
+        if (derivation > 1) {
             derivation = 1;
-        }else if (derivation < 0){
+        } else if (derivation < 0) {
             derivation = 0;
         }
         DERIVATION = derivation;
diff --git a/src/main/java/util/driver/DriverHelper.java b/src/main/java/util/driver/DriverHelper.java
@@ -22,6 +22,12 @@ public class DriverHelper {
 
     private final static Logger LOG = LoggerFactory.getLogger(DriverHelper.class);
 
+    /**
+     * Sending the keys into web element with click and clear
+     *
+     * @param element
+     * @param text
+     */
     public static void sendKeys(WebElement element, String text) {
         element.click();
         element.clear();
@@ -30,31 +36,64 @@ public static void sendKeys(WebElement element, String text) {
         LOG.info("Send text: " + text);
     }
 
+    /**
+     * Sending keys into mobile element with full clearing (iOS driver)
+     *
+     * @param driver
+     * @param element
+     * @param text
+     */
     public static void sendKeysFullClear(AndroidDriver driver, MobileElement element, String text) {
         MobileHelper.clearField(driver, element).sendKeys(text);
         driver.pressKeyCode(84);
 
         LOG.info("Send text: " + text);
     }
 
+    /**
+     * Scroll down web page for 1000px
+     *
+     * @param driver
+     */
     public static void scrollDownWeb(WebDriver driver) {
         JavascriptExecutor jse = (JavascriptExecutor) driver;
         jse.executeScript("window.scroll(0,1000)", "");
     }
 
+    /**
+     * Scroll up web page for 1000px
+     *
+     * @param driver
+     */
     public static void scrollUpWeb(WebDriver driver) {
         JavascriptExecutor jse = (JavascriptExecutor) driver;
         jse.executeScript("window.scroll(0,-1000)", "");
     }
 
+    /**
+     * Swipe down mobile page with duration 1sec
+     *
+     * @param driver
+     */
     public static void scrollDownMobile(AppiumDriver driver) {
         scrollDownMobile(driver, 1000);
     }
 
+    /**
+     * Swipe up mobile page with duration 1sec
+     *
+     * @param driver
+     */
     public static void scrollUpMobile(AppiumDriver driver) {
         scrollUpMobile(driver, 1000);
     }
 
+    /**
+     * Swipe down mobile page
+     *
+     * @param driver
+     * @param duration
+     */
     public static void scrollDownMobile(AppiumDriver driver, int duration) {
         Dimension dimensions = driver.manage().window().getSize();
         int screenHeightStart = dimensions.getHeight() / 2;
@@ -63,6 +102,12 @@ public static void scrollDownMobile(AppiumDriver driver, int duration) {
         driver.swipe(screenWidthStart, screenHeightStart, screenWidthStart, 0, duration);
     }
 
+    /**
+     * Swipe up mobile page
+     *
+     * @param driver
+     * @param duration
+     */
     public static void scrollUpMobile(AppiumDriver driver, int duration) {
         Dimension dimensions = driver.manage().window().getSize();
         int screenHeightStart = dimensions.getHeight() / 2;
@@ -102,6 +147,12 @@ public static void scrollUpMobileElement(AppiumDriver driver, MobileElement elem
         LOG.info("Scroll up element " + element.getId());
     }
 
+    /**
+     * zoom In/Out the page
+     *
+     * @param driver
+     * @param zoomPercent
+     */
     public static void zoomInOutPage(WebDriver driver, int zoomPercent) {
         if (zoomPercent > 0) {
             JavascriptExecutor jse = (JavascriptExecutor) driver;
@@ -124,6 +175,11 @@ public static String takeScreenshot(WebDriver driver) throws Exception {
         return fullFileName;
     }
 
+    /**
+     * Hide keyboard for iOS and Android in single method
+     *
+     * @param driver
+     */
     public static void hideKeyboard(AppiumDriver driver) {
         if (isIOS()) {
             Dimension dimensions = driver.manage().window().getSize();
@@ -164,6 +220,18 @@ public static void click(WebDriver driver, WebElement element) {
         }
     }
 
+    /**
+     * Click web element by location using clickPoint:
+     * TOP_LEFT,
+     * TOP_RIGHT,
+     * BOTTOM_LEFT,
+     * BOTTOM_RIGHT,
+     * CENTER
+     *
+     * @param driver
+     * @param element
+     * @param clickPoint
+     */
     public static void clickByLocation(WebDriver driver, WebElement element, ClickPoint clickPoint) {
         Point location = element.getLocation();
         Dimension size = element.getSize();
@@ -190,6 +258,18 @@ public static void clickByLocation(WebDriver driver, WebElement element, ClickPo
         LOG.info("INFO", "Click on " + clickPoint + " point");
     }
 
+    /**
+     * Click mobile element by location using clickPoint:
+     * TOP_LEFT,
+     * TOP_RIGHT,
+     * BOTTOM_LEFT,
+     * BOTTOM_RIGHT,
+     * CENTER
+     *
+     * @param driver
+     * @param element
+     * @param clickPoint
+     */
     public static void clickByLocation(AppiumDriver driver, MobileElement element, ClickPoint clickPoint) {
         Point location = element.getLocation();
         Dimension size = element.getSize();
@@ -215,6 +295,12 @@ public static void clickByLocation(AppiumDriver driver, MobileElement element, C
         LOG.info("INFO", "Click on " + clickPoint + " point");
     }
 
+    /**
+     * Click on element using JQuery click()
+     *
+     * @param driver
+     * @param element
+     */
     public static void clickJQuery(WebDriver driver, WebElement element) {
         JavascriptExecutor executor = (JavascriptExecutor) driver;
         if (!element.getAttribute("id").equals("")) {
@@ -224,6 +310,12 @@ public static void clickJQuery(WebDriver driver, WebElement element) {
         }
     }
 
+    /**
+     * Wait for Web page is loaded
+     *
+     * @param driver
+     * @return
+     */
     public static boolean waitForPageIsReady(WebDriver driver) {
 
         WebDriverWait wait = new WebDriverWait(driver, 30);
diff --git a/src/main/java/util/general/SystemHelper.java b/src/main/java/util/general/SystemHelper.java
@@ -7,6 +7,12 @@
 import static util.validator.Constants.TARGET_AUTOMOTION_JSON;
 
 public class SystemHelper {
+
+    /**
+     * Verify is display is retina
+     *
+     * @return
+     */
     public static boolean isRetinaDisplay() {
         boolean isRetina = false;
         try {
@@ -30,6 +36,13 @@ public static boolean isRetinaDisplay() {
         return isRetina;
     }
 
+    /**
+     * Convert hex color to rgb or rgba
+     *
+     * @param hexARGB
+     * @return
+     * @throws IllegalArgumentException
+     */
     public static String hexStringToARGB(String hexARGB) throws IllegalArgumentException {
 
         if (!hexARGB.startsWith("#") || !(hexARGB.length() == 7 || hexARGB.length() == 9)) {
@@ -57,7 +70,7 @@ public static String hexStringToARGB(String hexARGB) throws IllegalArgumentExcep
         }
     }
 
-    public static boolean isAutomotionFolderExists(){
+    public static boolean isAutomotionFolderExists() {
         File file = new File(TARGET_AUTOMOTION_JSON);
 
         return file.exists() && file.isDirectory() && file.list() != null && file.list().length > 0;
diff --git a/src/main/java/util/validator/LanguageChecker.java b/src/main/java/util/validator/LanguageChecker.java
@@ -22,6 +22,13 @@ public class LanguageChecker {
 
     private static final Logger LOG = Logger.getLogger(LanguageChecker.class);
 
+    /**
+     * Return recognized language on the page. E.g: 'en', 'es', ...
+     *
+     * @param text
+     * @return
+     * @throws IOException
+     */
     public static Optional<LdLocale> getRecognisedLanguage(String text) throws IOException {
         List<LanguageProfile> languageProfiles = new LanguageProfileReader().readAllBuiltIn();
 
@@ -36,6 +43,13 @@ public static Optional<LdLocale> getRecognisedLanguage(String text) throws IOExc
         return languageDetector.detect(textObject);
     }
 
+    /**
+     * Return recognized language on the page. E.g: 'en', 'es', ...
+     *
+     * @param driver
+     * @return
+     * @throws IOException
+     */
     public static Optional<LdLocale> getRecognisedLanguage(WebDriver driver) throws IOException {
         List<LanguageProfile> languageProfiles = new LanguageProfileReader().readAllBuiltIn();
 
@@ -50,6 +64,14 @@ public static Optional<LdLocale> getRecognisedLanguage(WebDriver driver) throws
         return languageDetector.detect(textObject);
     }
 
+    /**
+     * Verify if correct language on the web/mobile page
+     *
+     * @param driver
+     * @param lang
+     * @return
+     * @throws IOException
+     */
     public static boolean isCorrectLanguageOnThePage(WebDriver driver, String lang) throws IOException {
         boolean isCorrectLang = true;
         String bodyText = getTextFromPage(driver);
