com.facebook.testing.screenshot.RecordBuilder Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of core Show documentation

Screenshot Tests for Android

There is a newer version: 0.15.0

/**
 * Copyright (c) 2014-present, Facebook, Inc.
 * All rights reserved.
 *
 * This source code is licensed under the BSD-style license found in the
 * LICENSE file in the root directory of this source tree. An additional grant
 * of patent rights can be found in the PATENTS file in the same directory.
 */

package com.facebook.testing.screenshot;

/**
 * Builds all the information related to a screenshot.
 */
public interface RecordBuilder {
  /**
   * Set a name (identifier) for the screenshot. If you skip the name
   * a name will be generated based on the Test class and Test method
   * name this is being run from. That means if you have multiple
   * screenshots in the same test, then you have to explicitly specify
   * names to disambiguate.
   */
  public RecordBuilder setName(String name);

  /**
   * Set a long description of the what the screenshot is about.
   */
  public RecordBuilder setDescription(String description);

  /**
   * Add extra metadata about this screenshots.
   *
   * There will be no semantic information associated with this
   * metadata, but we'll try to provide this as debugging information
   * whenever you're viewing screenshots.
   */
  public RecordBuilder addExtra(String key, String value);

  /**
   * Finish the recording.
   */
  public void record();
}