1 /**
2 * Licensed to the Apache Software Foundation (ASF) under one
3 * or more contributor license agreements. See the NOTICE file
4 * distributed with this work for additional information
5 * regarding copyright ownership. The ASF licenses this file
6 * to you under the Apache License, Version 2.0 (the
7 * "License"); you may not use this file except in compliance
8 * with the License. You may obtain a copy of the License at
9 *
10 * http://www.apache.org/licenses/LICENSE-2.0
11 *
12 * Unless required by applicable law or agreed to in writing, software
13 * distributed under the License is distributed on an "AS IS" BASIS,
14 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15 * See the License for the specific language governing permissions and
16 * limitations under the License.
17 */
18 package org.apache.hadoop.hbase.hbtop.screen.help;
19
20 import java.util.ArrayList;
21 import java.util.Collections;
22 import java.util.List;
23 import java.util.Objects;
24
25 import org.apache.hadoop.hbase.classification.InterfaceAudience;
26
27 /**
28 * Represents a description of a command that we can execute in the top screen.
29 */
30 @InterfaceAudience.Private
31 public class CommandDescription {
32
33 private final List<String> keys;
34 private final String description;
35
36 public CommandDescription(String key, String description) {
37 this(Collections.singletonList(Objects.requireNonNull(key)), description);
38 }
39
40 public CommandDescription(List<String> keys, String description) {
41 this.keys = Collections.unmodifiableList(new ArrayList<>(Objects.requireNonNull(keys)));
42 this.description = Objects.requireNonNull(description);
43 }
44
45 public List<String> getKeys() {
46 return keys;
47 }
48
49 public String getDescription() {
50 return description;
51 }
52 }