| /* |
| * Copyright 2017 The Bazel Authors. 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.idea.blaze.base.command.buildresult; |
| |
| import com.google.common.collect.ImmutableList; |
| import com.google.idea.blaze.base.async.process.LineProcessingOutputStream.LineProcessor; |
| import com.google.idea.blaze.base.model.BlazeVersionData; |
| import com.google.idea.blaze.base.model.primitives.Label; |
| import java.io.Closeable; |
| import java.io.File; |
| import java.io.OutputStream; |
| import java.util.List; |
| import java.util.function.Predicate; |
| |
| /** Assists in getting build artifacts from a build operation. */ |
| public interface BuildResultHelper extends Closeable { |
| |
| /** |
| * Constructs a new build result helper. |
| * |
| * @param blazeVersion The blaze version used for the build invocation. |
| * @param files A filter for the output artifacts you are interested in. |
| */ |
| static BuildResultHelper forFiles(BlazeVersionData blazeVersion, Predicate<String> files) { |
| return new BuildResultHelperBep(files); |
| } |
| |
| /** |
| * Returns the build flags necessary for the build result helper to work. |
| * |
| * <p>The user must add these flags to their build command. |
| */ |
| List<String> getBuildFlags(); |
| |
| /** |
| * Returns an output stream to be passed to the external task's stderr. |
| * |
| * <p>The user must pipe blaze's stderr to this output stream. |
| * |
| * @param lineProcessors Any additional line processors you want on stderr output. |
| */ |
| OutputStream stderr(LineProcessor... lineProcessors); |
| |
| /** |
| * Returns the build result. May only be called once the build is complete, or no artifacts will |
| * be returned. |
| * |
| * @return The build artifacts from the build operation. |
| */ |
| ImmutableList<File> getBuildArtifacts(); |
| |
| /** |
| * Returns the build artifacts, attempting to filter out all artifacts not directly produced by |
| * the specified target. Some implementations may return artifacts produced by other targets. |
| * |
| * <p>May only be called once the build is complete, or no artifacts will be returned. |
| */ |
| ImmutableList<File> getBuildArtifactsForTarget(Label target); |
| |
| @Override |
| void close(); |
| } |