blob: 83618a2554f41fd0cb12d97f68d569150060f03e (
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
|
/*
* Copyright (C) 2018 The Android Open Source Project
*
* 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.android.dialer.commandline;
import android.support.annotation.NonNull;
import com.google.common.util.concurrent.ListenableFuture;
/** Handles a Command from {@link CommandLineReceiver}. */
public interface Command {
/**
* Thrown when {@code args} in {@link #run(Arguments)} does not match the expected format. The
* commandline will print {@code message} and {@link #getUsage()}.
*/
class IllegalCommandLineArgumentException extends Exception {
public IllegalCommandLineArgumentException(String message) {
super(message);
}
}
/** Describe the command when "help" is listing available commands. */
@NonNull
String getShortDescription();
/**
* Call when 'command --help' is called or when {@link IllegalCommandLineArgumentException} is
* thrown to inform the user how should the command be used.
*/
@NonNull
String getUsage();
ListenableFuture<String> run(Arguments args) throws IllegalCommandLineArgumentException;
}
|
