org.openqa.selenium.remote.ResponseCodec Maven / Gradle / Ivy

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.19.1

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 java.util.function.Supplier;

/**
 * Converts {@link Response} objects to and from another representation.
 *
 * @param  The type of an encoded response.
 */
public interface ResponseCodec {

  /**
   * Encodes a response.
   *
   * @param factory creates a new instance of {@code T}.
   * @param response the response to encode.
   * @return the encoded response.
   * @throws IllegalArgumentException If the object cannot be encoded.
   */
  T encode(Supplier factory, Response response);

  /**
   * Decodes a response.
   *
   * @param encodedResponse the response to decode.
   * @return the decoded response.
   * @throws IllegalArgumentException If the object cannot be decoded.
   */
  Response decode(T encodedResponse);
}