org.openqa.selenium.devtools.Command Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of selenium-remote-driver Show documentation

Selenium automates browsers. That's it! What you do with that power is entirely up to you.

There is a newer version: 4.26.0

Show newest version

// Licensed to the Software Freedom Conservancy (SFC) under one
// or more contributor license agreements.  See the NOTICE file
// distributed with this work for additional information
// regarding copyright ownership.  The SFC licenses this file
// to you 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.

package org.openqa.selenium.devtools;

import java.lang.reflect.Type;
import java.util.Map;
import java.util.function.Function;
import org.openqa.selenium.internal.Require;
import org.openqa.selenium.json.JsonInput;

public class Command {

  private final String method;
  private final Map params;
  private final Function mapper;
  private final boolean sendsResponse;

  public Command(String method, Map params) {
    this(method, params, Object.class);
  }

  public Command(String method, Map params, Type typeOfX) {
    this(method, params, input -> input.read(Require.nonNull("Type to convert to", typeOfX)));
  }

  public Command(String method, Map params, Function mapper) {
    this(method, params, mapper, true);
  }

  private Command(
      String method,
      Map params,
      Function mapper,
      boolean sendsResponse) {
    this.method = Require.nonNull("Method name", method);
    this.params = Map.copyOf(Require.nonNull("Command parameters", params));
    this.mapper = Require.nonNull("Mapper for result", mapper);

    this.sendsResponse = sendsResponse;
  }

  public String getMethod() {
    return method;
  }

  public Map getParams() {
    return params;
  }

  Function getMapper() {
    return mapper;
  }

  public boolean getSendsResponse() {
    return sendsResponse;
  }

  /**
   * Some CDP commands do not appear to send responses, and so are really hard to deal with. Work
   * around that by flagging those commands.
   */
  public Command doesNotSendResponse() {
    return new Command<>(method, params, mapper, false);
  }
}