blob: 61f46a8713ce1396c1b298f3ef06407d34848532 (
plain)
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
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
|
// 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.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 runtime The Blaze runtime requesting the execution of the command
* @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(BlazeRuntime runtime, 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 runtime The Blaze runtime requesting the execution of the command
*
* @throws AbruptExitException if something went wrong
*/
void editOptions(BlazeRuntime runtime, OptionsParser optionsParser) throws AbruptExitException;
}
|
