src/com/facebook/buck/rules/BuildableContext.java

/*
 * Copyright 2013-present Facebook, Inc.
 *
 * 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.
 */

package com.facebook.buck.rules;

import java.nio.file.Path;


/**
 * Context object that is specific to an individual {@link Buildable}.
 * This differs from {@link BuildContext} in that a {@link BuildContext} is a context that is shared
 * by all {@link Buildable}s whereas a new {@link BuildableContext} is created for each call to
 * {@link Buildable#getBuildSteps(BuildContext, BuildableContext)}.
 */
public interface BuildableContext {

  /**
   * When building a {@link BuildRule}, any metadata about the output files for the rule should be
   * recorded via this method. This ensures it will be stored in the {@link ArtifactCache} along
   * with the output.
   * <p>
   * If a value for the specified {@code key} has already been set, an exception will be thrown.
   * (If we discover a good reason for this to be allowed later, we can always relax this
   * constraint.)
   */
  public void addMetadata(String key, String value);

  /**
   * @see BuildInfoRecorder#recordArtifact(Path)
   */
  public void recordArtifact(Path pathToArtifact);
}