com.github.testsmith.cdt.protocol.commands.IO 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.testsmith.cdt.protocol.commands;

/*-
 * #%L
 * cdt-java-client
 * %%
 * Copyright (C) 2018 - 2024 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.testsmith.cdt.protocol.support.annotations.Optional;
import com.github.testsmith.cdt.protocol.support.annotations.ParamName;
import com.github.testsmith.cdt.protocol.support.annotations.Returns;
import com.github.testsmith.cdt.protocol.types.io.Read;

/**
 * Input/Output operations for streams produced by DevTools.
 *
 * @author roy
 * @version $Id: $Id
 */
public interface IO {

  /**
   * Close the stream, discard any temporary backing storage.
   *
   * @param handle Handle of the stream to close.
   */
  void close(@ParamName("handle") String handle);

  /**
   * Read a chunk of the stream
   *
   * @param handle Handle of the stream to read.
   * @return a {@link com.github.testsmith.cdt.protocol.types.io.Read} object
   */
  Read read(@ParamName("handle") String handle);

  /**
   * Read a chunk of the stream
   *
   * @param handle Handle of the stream to read.
   * @param offset Seek to the specified offset before reading (if not specificed, proceed with
   *     offset following the last read). Some types of streams may only support sequential reads.
   * @param size Maximum number of bytes to read (left upon the agent discretion if not specified).
   * @return a {@link com.github.testsmith.cdt.protocol.types.io.Read} object
   */
  Read read(
      @ParamName("handle") String handle,
      @Optional @ParamName("offset") Integer offset,
      @Optional @ParamName("size") Integer size);

  /**
   * Return UUID of Blob object specified by a remote object id.
   *
   * @param objectId Object id of a Blob object wrapper.
   * @return a {@link java.lang.String} object
   */
  @Returns("uuid")
  String resolveBlob(@ParamName("objectId") String objectId);
}