| // Copyright 2014 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.devtools.build.lib.runtime; |
| |
| import com.google.devtools.build.lib.util.AbruptExitException; |
| import com.google.devtools.build.lib.util.ExitCode; |
| import com.google.devtools.common.options.OptionsParser; |
| import com.google.devtools.common.options.OptionsProvider; |
| |
| /** |
| * Interface implemented by Blaze commands. In addition to implementing this interface, each |
| * command must be annotated with a {@link Command} annotation. |
| */ |
| public interface BlazeCommand { |
| /** |
| * This method provides the imperative portion of the command. It takes |
| * a {@link OptionsProvider} instance {@code options}, which provides access |
| * to the options instances via {@link OptionsProvider#getOptions(Class)}, |
| * and access to the residue (the remainder of the command line) via |
| * {@link OptionsProvider#getResidue()}. The framework parses and makes |
| * available exactly the options that the command class specifies via the |
| * annotation {@link Command#options()}. The command may write to standard |
| * out and standard error via {@code outErr}. It indicates success / failure |
| * via its return value, which becomes the Unix exit status of the Blaze |
| * client process. It may indicate a shutdown request by throwing |
| * {@link BlazeCommandDispatcher.ShutdownBlazeServerException}. In that case, |
| * the Blaze server process (the memory resident portion of Blaze) will |
| * shut down and the exit status will be 0 (in case the shutdown succeeds |
| * without error). |
| * |
| * @param env The environment for the current command invocation |
| * @param options A parsed options instance initialized with the values for |
| * the options specified in {@link Command#options()}. |
| * |
| * @return The Unix exit status for the Blaze client. |
| * @throws BlazeCommandDispatcher.ShutdownBlazeServerException Indicates |
| * that the command wants to shutdown the Blaze server. |
| */ |
| ExitCode exec(CommandEnvironment env, OptionsProvider options) |
| throws BlazeCommandDispatcher.ShutdownBlazeServerException; |
| |
| /** |
| * Allows the command to provide command-specific option defaults and/or |
| * requirements. This method is called after all command-line and rc file options have been |
| * parsed. |
| * |
| * @param env the command environment of the currently running command |
| * @param optionsParser the options parser for the current command |
| * |
| * @throws AbruptExitException if something went wrong |
| */ |
| void editOptions(CommandEnvironment env, OptionsParser optionsParser) throws AbruptExitException; |
| } |