src/main/java/com/google/devtools/build/lib/analysis/actions/FileWriteActionContext.java


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44

// Copyright 2014 Google Inc. All rights reserved.
//
// 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.google.devtools.build.lib.analysis.actions;

import com.google.devtools.build.lib.actions.ActionExecutionContext;
import com.google.devtools.build.lib.actions.ExecException;
import com.google.devtools.build.lib.actions.Executor;
import com.google.devtools.build.lib.actions.Executor.ActionContext;
import com.google.devtools.build.lib.actions.ResourceSet;
import com.google.devtools.build.lib.util.io.FileOutErr;

/**
 * The action context for {@link AbstractFileWriteAction} instances (technically instances of
 * subclasses).
 */
public interface FileWriteActionContext extends ActionContext {

  /**
   * Performs all the setup and then calls back into the action to write the data.
   */
  void exec(Executor executor, AbstractFileWriteAction action, FileOutErr outErr,
      ActionExecutionContext actionExecutionContext) throws ExecException, InterruptedException;

  /**
   * Returns the estimated resource consumption of the action.
   */
  ResourceSet estimateResourceConsumption(AbstractFileWriteAction action);

  /**
   * Returns where the action actually runs.
   */
  String strategyLocality(AbstractFileWriteAction action);
}