Merge pull request #24 from kklisura/return-types

Return types

Author: kklisura

cdt-examples/src/main/java/com/github/kklisura/cdt/examples/PerformanceMetricsExample.java

@@ -0,0 +1,62 @@
+package com.github.kklisura.cdt.examples;
+
+import com.github.kklisura.cdt.launch.ChromeLauncher;
+import com.github.kklisura.cdt.protocol.commands.Network;
+import com.github.kklisura.cdt.protocol.commands.Page;
+import com.github.kklisura.cdt.protocol.commands.Performance;
+import com.github.kklisura.cdt.protocol.types.performance.Metric;
+import com.github.kklisura.cdt.services.ChromeDevToolsService;
+import com.github.kklisura.cdt.services.ChromeService;
+import com.github.kklisura.cdt.services.types.ChromeTab;
+
+import java.util.List;
+
+/**
+ * Metric example
+ *
+ * @author Kenan Klisura
+ */
+public class PerformanceMetricsExample {
+  public static void main(String[] args) {
+    // Create chrome launcher.
+    final ChromeLauncher launcher = new ChromeLauncher();
+
+    // Launch chrome either as headless (true) or regular (false).
+    final ChromeService chromeService = launcher.launch(false);
+
+    // Create empty tab ie about:blank.
+    final ChromeTab tab = chromeService.createTab();
+
+    // Get DevTools service to this tab
+    final ChromeDevToolsService devToolsService = chromeService.createDevToolsService(tab);
+
+    // Get individual commands
+    final Page page = devToolsService.getPage();
+    final Network network = devToolsService.getNetwork();
+    final Performance performance = devToolsService.getPerformance();
+
+    performance.enable();
+    network.onLoadingFinished(
+        event -> {
+          // Close the tab and close the browser when loading finishes.
+          List<Metric> metrics = performance.getMetrics();
+          try {
+            for (Metric metric : metrics) {
+              System.out.println(metric.getName() + ": " + metric.getValue());
+            }
+          } catch (Exception e) {
+            System.out.println(e.getMessage());
+          }
+          chromeService.closeTab(tab);
+          launcher.close();
+        });
+
+    // Enable network events.
+    network.enable();
+
+    // Navigate to github.com.
+    page.navigate("https://www.github.com");
+
+    devToolsService.waitUntilClosed();
+  }
+}

cdt-java-client/src/main/java/com/github/kklisura/cdt/protocol/ChromeDevTools.java

@@ -4,7 +4,7 @@
  * #%L
  * cdt-java-client
  * %%
- * Copyright (C) 2018 Kenan Klisura
+ * Copyright (C) 2018 - 2019 Kenan Klisura
  * %%
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

cdt-java-client/src/main/java/com/github/kklisura/cdt/protocol/commands/Accessibility.java

@@ -4,7 +4,7 @@
  * #%L
  * cdt-java-client
  * %%
- * Copyright (C) 2018 Kenan Klisura
+ * Copyright (C) 2018 - 2019 Kenan Klisura
  * %%
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -23,6 +23,7 @@
 import com.github.kklisura.cdt.protocol.support.annotations.Experimental;
 import com.github.kklisura.cdt.protocol.support.annotations.Optional;
 import com.github.kklisura.cdt.protocol.support.annotations.ParamName;
+import com.github.kklisura.cdt.protocol.support.annotations.ReturnTypeParameter;
 import com.github.kklisura.cdt.protocol.support.annotations.Returns;
 import com.github.kklisura.cdt.protocol.types.accessibility.AXNode;
 import java.util.List;
@@ -35,6 +36,7 @@ public interface Accessibility {
    */
   @Experimental
   @Returns("nodes")
+  @ReturnTypeParameter(AXNode.class)
   List<AXNode> getPartialAXTree();
 
   /**
@@ -49,6 +51,7 @@ public interface Accessibility {
    */
   @Experimental
   @Returns("nodes")
+  @ReturnTypeParameter(AXNode.class)
   List<AXNode> getPartialAXTree(
       @Optional @ParamName("nodeId") Integer nodeId,
       @Optional @ParamName("backendNodeId") Integer backendNodeId,

cdt-java-client/src/main/java/com/github/kklisura/cdt/protocol/commands/Animation.java

@@ -4,7 +4,7 @@
  * #%L
  * cdt-java-client
  * %%
- * Copyright (C) 2018 Kenan Klisura
+ * Copyright (C) 2018 - 2019 Kenan Klisura
  * %%
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

cdt-java-client/src/main/java/com/github/kklisura/cdt/protocol/commands/ApplicationCache.java

@@ -4,7 +4,7 @@
  * #%L
  * cdt-java-client
  * %%
- * Copyright (C) 2018 Kenan Klisura
+ * Copyright (C) 2018 - 2019 Kenan Klisura
  * %%
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -25,6 +25,7 @@
 import com.github.kklisura.cdt.protocol.support.annotations.EventName;
 import com.github.kklisura.cdt.protocol.support.annotations.Experimental;
 import com.github.kklisura.cdt.protocol.support.annotations.ParamName;
+import com.github.kklisura.cdt.protocol.support.annotations.ReturnTypeParameter;
 import com.github.kklisura.cdt.protocol.support.annotations.Returns;
 import com.github.kklisura.cdt.protocol.support.types.EventHandler;
 import com.github.kklisura.cdt.protocol.support.types.EventListener;
@@ -52,6 +53,7 @@ public interface ApplicationCache {
    * associated with some application cache.
    */
   @Returns("frameIds")
+  @ReturnTypeParameter(FrameWithManifest.class)
   List<FrameWithManifest> getFramesWithManifests();
 
   /**

cdt-java-client/src/main/java/com/github/kklisura/cdt/protocol/commands/Audits.java

@@ -4,7 +4,7 @@
  * #%L
  * cdt-java-client
  * %%
- * Copyright (C) 2018 Kenan Klisura
+ * Copyright (C) 2018 - 2019 Kenan Klisura
  * %%
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

cdt-java-client/src/main/java/com/github/kklisura/cdt/protocol/commands/Browser.java

@@ -4,7 +4,7 @@
  * #%L
  * cdt-java-client
  * %%
- * Copyright (C) 2018 Kenan Klisura
+ * Copyright (C) 2018 - 2019 Kenan Klisura
  * %%
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -23,6 +23,7 @@
 import com.github.kklisura.cdt.protocol.support.annotations.Experimental;
 import com.github.kklisura.cdt.protocol.support.annotations.Optional;
 import com.github.kklisura.cdt.protocol.support.annotations.ParamName;
+import com.github.kklisura.cdt.protocol.support.annotations.ReturnTypeParameter;
 import com.github.kklisura.cdt.protocol.support.annotations.Returns;
 import com.github.kklisura.cdt.protocol.types.browser.Bounds;
 import com.github.kklisura.cdt.protocol.types.browser.Histogram;
@@ -45,11 +46,13 @@ public interface Browser {
    */
   @Experimental
   @Returns("arguments")
+  @ReturnTypeParameter(String.class)
   List<String> getBrowserCommandLine();
 
   /** Get Chrome histograms. */
   @Experimental
   @Returns("histograms")
+  @ReturnTypeParameter(Histogram.class)
   List<Histogram> getHistograms();
 
   /**
@@ -61,6 +64,7 @@ public interface Browser {
    */
   @Experimental
   @Returns("histograms")
+  @ReturnTypeParameter(Histogram.class)
   List<Histogram> getHistograms(
       @Optional @ParamName("query") String query, @Optional @ParamName("delta") Boolean delta);
 

cdt-java-client/src/main/java/com/github/kklisura/cdt/protocol/commands/CSS.java

@@ -4,7 +4,7 @@
  * #%L
  * cdt-java-client
  * %%
- * Copyright (C) 2018 Kenan Klisura
+ * Copyright (C) 2018 - 2019 Kenan Klisura
  * %%
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -28,6 +28,7 @@
 import com.github.kklisura.cdt.protocol.support.annotations.EventName;
 import com.github.kklisura.cdt.protocol.support.annotations.Experimental;
 import com.github.kklisura.cdt.protocol.support.annotations.ParamName;
+import com.github.kklisura.cdt.protocol.support.annotations.ReturnTypeParameter;
 import com.github.kklisura.cdt.protocol.support.annotations.Returns;
 import com.github.kklisura.cdt.protocol.support.types.EventHandler;
 import com.github.kklisura.cdt.protocol.support.types.EventListener;
@@ -77,6 +78,7 @@ CSSRule addRule(
    * @param styleSheetId
    */
   @Returns("classNames")
+  @ReturnTypeParameter(String.class)
   List<String> collectClassNames(@ParamName("styleSheetId") String styleSheetId);
 
   /**
@@ -116,6 +118,7 @@ void forcePseudoState(
    * @param nodeId
    */
   @Returns("computedStyle")
+  @ReturnTypeParameter(CSSComputedStyleProperty.class)
   List<CSSComputedStyleProperty> getComputedStyleForNode(@ParamName("nodeId") Integer nodeId);
 
   /**
@@ -135,6 +138,7 @@ void forcePseudoState(
 
   /** Returns all media queries parsed by the rendering engine. */
   @Returns("medias")
+  @ReturnTypeParameter(CSSMedia.class)
   List<CSSMedia> getMediaQueries();
 
   /**
@@ -144,6 +148,7 @@ void forcePseudoState(
    * @param nodeId
    */
   @Returns("fonts")
+  @ReturnTypeParameter(PlatformFontUsage.class)
   List<PlatformFontUsage> getPlatformFontsForNode(@ParamName("nodeId") Integer nodeId);
 
   /**
@@ -222,6 +227,7 @@ String setStyleSheetText(
    * @param edits
    */
   @Returns("styles")
+  @ReturnTypeParameter(CSSStyle.class)
   List<CSSStyle> setStyleTexts(@ParamName("edits") List<StyleDeclarationEdit> edits);
 
   /** Enables the selector recording. */
@@ -232,13 +238,15 @@ String setStyleSheetText(
    * `takeCoverageDelta` (or since start of coverage instrumentation)
    */
   @Returns("ruleUsage")
+  @ReturnTypeParameter(RuleUsage.class)
   List<RuleUsage> stopRuleUsageTracking();
 
   /**
    * Obtain list of rules that became used since last call to this method (or since start of
    * coverage instrumentation)
    */
   @Returns("coverage")
+  @ReturnTypeParameter(RuleUsage.class)
   List<RuleUsage> takeCoverageDelta();
 
   /**

cdt-java-client/src/main/java/com/github/kklisura/cdt/protocol/commands/CacheStorage.java

@@ -4,7 +4,7 @@
  * #%L
  * cdt-java-client
  * %%
- * Copyright (C) 2018 Kenan Klisura
+ * Copyright (C) 2018 - 2019 Kenan Klisura
  * %%
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -22,6 +22,7 @@
 
 import com.github.kklisura.cdt.protocol.support.annotations.Experimental;
 import com.github.kklisura.cdt.protocol.support.annotations.ParamName;
+import com.github.kklisura.cdt.protocol.support.annotations.ReturnTypeParameter;
 import com.github.kklisura.cdt.protocol.support.annotations.Returns;
 import com.github.kklisura.cdt.protocol.types.cachestorage.Cache;
 import com.github.kklisura.cdt.protocol.types.cachestorage.CachedResponse;
@@ -52,6 +53,7 @@ public interface CacheStorage {
    * @param securityOrigin Security origin.
    */
   @Returns("caches")
+  @ReturnTypeParameter(Cache.class)
   List<Cache> requestCacheNames(@ParamName("securityOrigin") String securityOrigin);
 
   /**

cdt-java-client/src/main/java/com/github/kklisura/cdt/protocol/commands/Console.java

@@ -4,7 +4,7 @@
  * #%L
  * cdt-java-client
  * %%
- * Copyright (C) 2018 Kenan Klisura
+ * Copyright (C) 2018 - 2019 Kenan Klisura
  * %%
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.