org.openqa.selenium.remote.CommandCodec 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.remote;

import org.openqa.selenium.UnsupportedCommandException;
import org.openqa.selenium.remote.http.HttpMethod;

/**
 * Converts {@link Command} objects to and from another representation.
 *
 * @param  The type of encoded command.
 */
public interface CommandCodec {

  /**
   * @return Whether this {@link CommandCodec} supports the given command name.
   */
  boolean isSupported(String commandName);

  /**
   * Encodes a command.
   *
   * @param command the command to encode.
   * @return the encoded command.
   * @throws UnsupportedCommandException If the command is not supported by this codec.
   */
  T encode(Command command);

  /**
   * Decodes a command.
   *
   * @param encodedCommand the command to decode.
   * @return the decoded command.
   * @throws UnsupportedCommandException If the command is not supported by this codec.
   */
  Command decode(T encodedCommand);

  /** Enhance this command codec with additional commands. */
  void defineCommand(String name, HttpMethod method, String pathPattern);

  /**
   * Allow commands to have aliases.
   *
   * @param commandName The command being added.
   * @param isAnAliasFor The command name that this is an alias for.
   */
  void alias(String commandName, String isAnAliasFor);
}