com.github.kklisura.cdt.services.ChromeDevToolsService Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of cdt-java-client Show documentation
Chrome DevTools java client
The newest version!
package com.github.kklisura.cdt.services;

/*-
 * #%L
 * cdt-java-client
 * %%
 * Copyright (C) 2018 - 2023 Kenan Klisura
 * %%
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 * #L%
 */

import com.github.kklisura.cdt.protocol.ChromeDevTools;
import com.github.kklisura.cdt.protocol.support.types.EventHandler;
import com.github.kklisura.cdt.protocol.support.types.EventListener;
import com.github.kklisura.cdt.services.exceptions.ChromeDevToolsInvocationException;
import com.github.kklisura.cdt.services.types.MethodInvocation;

/**
 * Chrome dev tools service.
 *
 * @author Kenan Klisura
 */
public interface ChromeDevToolsService extends ChromeDevTools, AutoCloseable {

  /**
   * Invokes a dev tools method. If your return types is a generics please use {@link
   * #invoke(String, Class, Class[], MethodInvocation)}.
   *
   * This method is deprecated and might be removed in future.
   *
   * @param returnProperty Return property.
   * @param clazz Return class type.
   * @param methodInvocation Method invocation definition.
   * @param  Type of a return class.
   * @return Return object.
   * @throws ChromeDevToolsInvocationException If invocation fails.
   * @deprecated Please use {@link #invoke(String, Class, Class[], MethodInvocation)}
   */
  @Deprecated
   T invoke(String returnProperty, Class clazz, MethodInvocation methodInvocation);

  /**
   * Invokes a dev tools method.
   *
   * @param returnProperty Return property.
   * @param clazz Return class type.
   * @param returnTypeClasses List of class to which returnType is parametrized with.
   * @param methodInvocation Method invocation definition.
   * @param  Type of a return class.
   * @return Return object.
   * @throws ChromeDevToolsInvocationException If invocation fails.
   */
   T invoke(
      String returnProperty,
      Class clazz,
      Class[] returnTypeClasses,
      MethodInvocation methodInvocation);

  /** Closes the dev tools service. */
  void close();

  /**
   * Returns true if devtools is closed.
   *
   * @return True if its closed.
   */
  boolean isClosed();

  /** Waits until devtools is closed. */
  void waitUntilClosed();

  /**
   * Adds an event listener on a given event name belonging to some domain.
   *
   * @param domainName Domain.
   * @param eventName Event.
   * @param eventHandler Event handler.
   * @param eventType Event type.
   * @return Event listener.
   */
  EventListener addEventListener(
      String domainName, String eventName, EventHandler eventHandler, Class eventType);

  /**
   * Removes an event listener.
   *
   * @param eventListener Event listener.
   */
  void removeEventListener(EventListener eventListener);
}