How to use call method of org.openqa.selenium.support.decorators.DefaultDecorated class

Best Selenium code snippet using org.openqa.selenium.support.decorators.DefaultDecorated.call

Source:WebDriverDecorator.java

...63 *   <li>when an exception is thrown by a method of the underlying object.</li>64 * </ul>65 * The same decorator is used under the hood to decorate all the objects66 * derived from the underlying WebDriver instance. For example,67 * <code>decorated.findElement(someLocator)</code> automatically decorates68 * the returned WebElement.69 * <p>70 * Instances created by the decorator implement all the same interfaces as71 * the original objects.72 * <p>73 * When you implement a decorator there are two main options (that can be used74 * both separately and together):75 * <ul>76 *   <li>if you want to apply the same behavior modification to all methods of77 *   a WebDriver instance and its derived objects you can subclass78 *   WebDriverDecorator and override some of the following methods:79 *   {@link #beforeCall(Decorated, Method, Object[])},80 *   {@link #afterCall(Decorated, Method, Object[], Object)},81 *   {@link #call(Decorated, Method, Object[])} and82 *   {@link #onError(Decorated, Method, Object[], InvocationTargetException)}</li>83 *   <li>if you want to modify behavior of a specific class instances only84 *   (e.g. behaviour of WebElement instances) you can override one of the85 *   overloaded <code>createDecorated</code> methods to create a non-trivial86 *   decorator for the specific class only.</li>87 * </ul>88 * Let's consider both approaches by examples.89 * <p>90 * One of the most widely used decorator examples is a logging decorator.91 * In this case we want to add the same piece of logging code before and after92 * each invoked method:93 * <code>94 *   public class LoggingDecorator extends WebDriverDecorator {95 *     final Logger logger = LoggerFactory.getLogger(Thread.currentThread().getName());96 *97 *     @Override98 *     public void beforeCall(Decorated<?> target, Method method, Object[] args) {99 *       logger.debug("before {}.{}({})", target, method, args);100 *     }101 *     @Override102 *     public void afterCall(Decorated<?> target, Method method, Object[] args, Object res) {103 *       logger.debug("after {}.{}({}) => {}", target, method, args, res);104 *     }105 *   }106 * </code>107 * For the second example let's implement a decorator that implicitly waits108 * for an element to be visible before any click or sendKeys method call.109 * <code>110 *   public class ImplicitlyWaitingDecorator extends WebDriverDecorator {111 *     private WebDriverWait wait;112 *113 *     @Override114 *     public Decorated<WebDriver> createDecorated(WebDriver driver) {115 *       wait = new WebDriverWait(driver, Duration.ofSeconds(10));116 *       return super.createDecorated(driver);117 *     }118 *     @Override119 *     public Decorated<WebElement> createDecorated(WebElement original) {120 *       return new DefaultDecorated<>(original, this) {121 *         @Override122 *         public void beforeCall(Method method, Object[] args) {123 *           String methodName = method.getName();124 *           if ("click".equals(methodName) || "sendKeys".equals(methodName)) {125 *             wait.until(d -> getOriginal().isDisplayed());126 *           }127 *         }128 *       };129 *     }130 *   }131 * </code>132 * This class is not a pure decorator, it allows to not only add new behavior133 * but also replace "normal" behavior of a WebDriver or derived objects.134 * <p>135 * Let's suppose you want to use JavaScript-powered clicks instead of normal136 * ones (yes, this allows to interact with invisible elements, it's a bad137 * practice in general but sometimes it's inevitable). This behavior change138 * can be achieved with the following "decorator":139 * <code>140 *   public class JavaScriptPoweredDecorator extends WebDriverDecorator {141 *     @Override142 *     public Decorated<WebElement> createDecorated(WebElement original) {143 *       return new DefaultDecorated<>(original, this) {144 *         @Override145 *         public Object call(Method method, Object[] args) throws Throwable {146 *           String methodName = method.getName();147 *           if ("click".equals(methodName)) {148 *             JavascriptExecutor executor = (JavascriptExecutor) getDecoratedDriver().getOriginal();149 *             executor.executeScript("arguments[0].click()", getOriginal());150 *             return null;151 *           } else {152 *             return super.call(method, args);153 *           }154 *         }155 *       };156 *     }157 *   }158 * </code>159 * It is possible to apply multiple decorators to compose behaviors added160 * by each of them. For example, if you want to log method calls and161 * implicitly wait for elements visibility you can use two decorators:162 * <code>163 *   WebDriver original = new FirefoxDriver();164 *   WebDriver decorated =165 *     new ImplicitlyWaitingDecorator().decorate(166 *       new LoggingDecorator().decorate(original));167 * </code>168 */169@Beta170public class WebDriverDecorator {171  private Decorated<WebDriver> decorated;172  public final WebDriver decorate(WebDriver original) {173    Require.nonNull("WebDriver", original);174    decorated = createDecorated(original);175    return createProxy(decorated);176  }177  public Decorated<WebDriver> getDecoratedDriver() {178    return decorated;179  }180  public Decorated<WebDriver> createDecorated(WebDriver driver) {181    return new DefaultDecorated<>(driver, this);182  }183  public Decorated<WebElement> createDecorated(WebElement original) {184    return new DefaultDecorated<>(original, this);185  }186  public Decorated<WebDriver.TargetLocator> createDecorated(WebDriver.TargetLocator original) {187    return new DefaultDecorated<>(original, this);188  }189  public Decorated<WebDriver.Navigation> createDecorated(WebDriver.Navigation original) {190    return new DefaultDecorated<>(original, this);191  }192  public Decorated<WebDriver.Options> createDecorated(WebDriver.Options original) {193    return new DefaultDecorated<>(original, this);194  }195  public Decorated<WebDriver.Timeouts> createDecorated(WebDriver.Timeouts original) {196    return new DefaultDecorated<>(original, this);197  }198  public Decorated<WebDriver.Window> createDecorated(WebDriver.Window original) {199    return new DefaultDecorated<>(original, this);200  }201  public Decorated<Alert> createDecorated(Alert original) {202    return new DefaultDecorated<>(original, this);203  }204  public Decorated<VirtualAuthenticator> createDecorated(VirtualAuthenticator original) {205    return new DefaultDecorated<>(original, this);206  }207  public void beforeCall(Decorated<?> target, Method method, Object[] args) {}208  public Object call(Decorated<?> target, Method method, Object[] args) throws Throwable {209    return decorateResult(method.invoke(target.getOriginal(), args));210  }211  public void afterCall(Decorated<?> target, Method method, Object[] args, Object res) {}212  public Object onError(Decorated<?> target, Method method, Object[] args,213                        InvocationTargetException e) throws Throwable214  {215    throw e.getTargetException();216  }217  private Object decorateResult(Object toDecorate) {218    if (toDecorate instanceof WebDriver) {219      return createProxy(getDecoratedDriver());220    }221    if (toDecorate instanceof WebElement) {222      return createProxy(createDecorated((WebElement) toDecorate));223    }224    if (toDecorate instanceof Alert) {225      return createProxy(createDecorated((Alert) toDecorate));226    }227    if (toDecorate instanceof VirtualAuthenticator) {228      return createProxy(createDecorated((VirtualAuthenticator) toDecorate));229    }230    if (toDecorate instanceof WebDriver.Navigation) {231      return createProxy(createDecorated((WebDriver.Navigation) toDecorate));232    }233    if (toDecorate instanceof WebDriver.Options) {234      return createProxy(createDecorated((WebDriver.Options) toDecorate));235    }236    if (toDecorate instanceof WebDriver.TargetLocator) {237      return createProxy(createDecorated((WebDriver.TargetLocator) toDecorate));238    }239    if (toDecorate instanceof WebDriver.Timeouts) {240      return createProxy(createDecorated((WebDriver.Timeouts) toDecorate));241    }242    if (toDecorate instanceof WebDriver.Window) {243      return createProxy(createDecorated((WebDriver.Window) toDecorate));244    }245    if (toDecorate instanceof List) {246      return ((List<?>) toDecorate).stream()247        .map(this::decorateResult)248        .collect(Collectors.toList());249    }250    return toDecorate;251  }252  protected final <Z> Z createProxy(final Decorated<Z> decorated) {253    Set<Class<?>> decoratedInterfaces = extractInterfaces(decorated);254    Set<Class<?>> originalInterfaces = extractInterfaces(decorated.getOriginal());255    final InvocationHandler handler = (proxy, method, args) -> {256      try {257        if (method.getDeclaringClass().equals(Object.class)258            || decoratedInterfaces.contains(method.getDeclaringClass())) {259          return method.invoke(decorated, args);260        }261        if (originalInterfaces.contains(method.getDeclaringClass())) {262          decorated.beforeCall(method, args);263          Object result = decorated.call(method, args);264          decorated.afterCall(method, result, args);265          return result;266        }267        return method.invoke(decorated.getOriginal(), args);268      } catch (InvocationTargetException e) {269        return decorated.onError(method, e, args);270      }271    };272    Set<Class<?>> allInterfaces = new HashSet<>();273    allInterfaces.addAll(decoratedInterfaces);274    allInterfaces.addAll(originalInterfaces);275    Class<?>[] allInterfacesArray = allInterfaces.toArray(new Class<?>[0]);276    return (Z) Proxy.newProxyInstance(277      this.getClass().getClassLoader(), allInterfacesArray, handler);...

Source:DefaultDecorated.java

...34  public void beforeCall(Method method, Object[] args) {35    getDecorator().beforeCall(this, method, args);36  }37  @Override38  public Object call(Method method, Object[] args) throws Throwable {39    return getDecorator().call(this, method, args);40  }41  @Override42  public void afterCall(Method method, Object result, Object[] args) {43    getDecorator().afterCall(this, method, args, result);44  }45  @Override46  public Object onError(Method method, InvocationTargetException e, Object[] args) throws Throwable {47    return getDecorator().onError(this, method, args, e);48  }49  @Override50  public String toString() {51    return String.format("Decorated {%s}", original);52  }53  @Override...

Source:WaitHelper.java

1package br.edu.mcesar.core;2import static br.edu.mcesar.core.CoreConstants.DEFAULT_TIMEOUT;3import java.lang.reflect.Method;4import java.time.Duration;5import org.openqa.selenium.WebDriver;6import org.openqa.selenium.WebElement;7import org.openqa.selenium.support.decorators.Decorated;8import org.openqa.selenium.support.decorators.DefaultDecorated;9import org.openqa.selenium.support.decorators.WebDriverDecorator;10import org.openqa.selenium.support.ui.ExpectedConditions;11import org.openqa.selenium.support.ui.WebDriverWait;12public class WaitHelper extends WebDriverDecorator {13	private final Duration TIMEOUT = Duration.ofMillis(DEFAULT_TIMEOUT.getValor());14	private WebDriver driver;15	private WebDriverWait wait;16	public WaitHelper(WebDriver webDriver) {17		driver = webDriver;18	}19	public WebElement waitForElementToBeDisplayed(WebElement element) {20		WebDriverWait wait = new WebDriverWait(driver, TIMEOUT);21		return wait.until(ExpectedConditions.visibilityOf(element));22	}23	@Override24    public Decorated<WebDriver> createDecorated(WebDriver driver) {25      wait = new WebDriverWait(driver, Duration.ofSeconds(10));26      return super.createDecorated(driver);27    }28    @Override29    public Decorated<WebElement> createDecorated(WebElement original) {30      return new DefaultDecorated<WebElement>(original, this) {31        @Override32        public void beforeCall(Method method, Object[] args) {33          String methodName = method.getName();34          if ("click".equals(methodName) || "sendKeys".equals(methodName)) {35            wait.until(d -> getOriginal().isDisplayed());36          }37        }38      };39    }40   }...

call

Using AI Code Generation

1package com.automation;2import org.openqa.selenium.By;3import org.openqa.selenium.WebDriver;4import org.openqa.selenium.WebElement;5import org.openqa.selenium.chrome.ChromeDriver;6import org.openqa.selenium.support.FindBy;7import org.openqa.selenium.support.PageFactory;8import org.openqa.selenium.support.pagefactory.DefaultElementLocatorFactory;9import org.openqa.selenium.support.pagefactory.ElementLocatorFactory;10import org.openqa.selenium.support.pagefactory.FieldDecorator;11import java.lang.reflect.Field;12import java.util.List;13public class Decorator {14    public static class DecoratorExample implements FieldDecorator {15        private final ElementLocatorFactory factory;16        public DecoratorExample(ElementLocatorFactory factory) {17            this.factory = factory;18        }19        public Object decorate(ClassLoader loader, Field field) {20            if (field.getAnnotation(FindBy.class) == null) {21                return null;22            }23            return factory.createLocator(field).findElement();24        }25    }26    public static class DecoratorListExample implements FieldDecorator {27        private final ElementLocatorFactory factory;28        public DecoratorListExample(ElementLocatorFactory factory) {29            this.factory = factory;30        }31        public Object decorate(ClassLoader loader, Field field) {32            if (field.getAnnotation(FindBy.class) == null) {33                return null;34            }35            return factory.createLocator(field).findElements();36        }37    }38    public static class PageObject {39        @FindBy(id = "someId")40        private WebElement element;41        @FindBy(id = "someId")42        private List<WebElement> elements;43        public PageObject(WebDriver driver) {44            ElementLocatorFactory factory = new DefaultElementLocatorFactory(driver);45            PageFactory.initElements(new DecoratorExample(factory), this);46            PageFactory.initElements(new DecoratorListExample(factory), this);47        }48        public WebElement getElement() {49            return element;50        }51        public List<WebElement> getElements() {52            return elements;53        }54    }55    public static void main(String[] args) {56        System.setProperty("webdriver.chrome.driver", "C:\\Users\\User\\Downloads\\chromedriver_win32\\chromedriver.exe");57        WebDriver driver = new ChromeDriver();58        PageObject pageObject = new PageObject(driver);59        pageObject.getElement().click();60        pageObject.getElements().get(0).click();61        driver.quit();62    }63}

call

Using AI Code Generation

1import org.openqa.selenium.WebDriver;2import org.openqa.selenium.support.decorators.DefaultDecorated;3import org.openqa.selenium.support.decorators.WebDriverDecorators;4import org.openqa.selenium.support.ui.ExpectedConditions;5import org.openqa.selenium.support.ui.WebDriverWait;6import org.openqa.selenium.chrome.ChromeDriver;7import org.openqa.selenium.By;8import org.openqa.selenium.WebElement;9public class DecoratorPattern {10	public static void main(String[] args) {11		System.setProperty("webdriver.chrome.driver", "C:\\Users\\sabasivam\\Downloads\\chromedriver_win32\\chromedriver.exe");12		WebDriver driver = new ChromeDriver();13		WebDriverDecorators decorator = new WebDriverDecorators();14		WebDriver decorated = decorator.decorate(driver);15		WebElement element = decorated.findElement(By.name("q"));16		element.sendKeys("Cheese!");17		element.submit();18		WebDriverWait wait = new WebDriverWait(decorated, 10);19		wait.until(ExpectedConditions.titleContains("Cheese!"));20		System.out.println("Page title is: " + decorated.getTitle());21		decorated.quit();22	}23}

Selenium 4 Tutorial:

LambdaTest’s Selenium 4 tutorial is covering every aspects of Selenium 4 testing with examples and best practices. Here you will learn basics, such as how to upgrade from Selenium 3 to Selenium 4, to some advanced concepts, such as Relative locators and Selenium Grid 4 for Distributed testing. Also will learn new features of Selenium 4, such as capturing screenshots of specific elements, opening a new tab or window on the browser, and new protocol adoptions.

Chapters:

Upgrading From Selenium 3 To Selenium 4?: In this chapter, learn in detail how to update Selenium 3 to Selenium 4 for Java binding. Also, learn how to upgrade while using different build tools such as Maven or Gradle and get comprehensive guidance for upgrading Selenium.
What’s New In Selenium 4 & What’s Being Deprecated? : Get all information about new implementations in Selenium 4, such as W3S protocol adaption, Optimized Selenium Grid, and Enhanced Selenium IDE. Also, learn what is deprecated for Selenium 4, such as DesiredCapabilites and FindsBy methods, etc.
Selenium 4 With Python: Selenium supports all major languages, such as Python, C#, Ruby, and JavaScript. In this chapter, learn how to install Selenium 4 for Python and the features of Python in Selenium 4, such as Relative locators, Browser manipulation, and Chrom DevTool protocol.
Selenium 4 Is Now W3C Compliant: JSON Wireframe protocol is retiring from Selenium 4, and they are adopting W3C protocol to learn in detail about the advantages and impact of these changes.
How To Use Selenium 4 Relative Locator? : Selenium 4 came with new features such as Relative Locators that allow constructing locators with reference and easily located constructors nearby. Get to know its different use cases with examples.
Selenium Grid 4 Tutorial For Distributed Testing: Selenium Grid 4 allows you to perform tests over different browsers, OS, and device combinations. It also enables parallel execution browser testing, reads up on various features of Selenium Grid 4 and how to download it, and runs a test on Selenium Grid 4 with best practices.
Selenium Video Tutorials: Binge on video tutorials on Selenium by industry experts to get step-by-step direction from automating basic to complex test scenarios with Selenium.