001/**
002 * Licensed to the Apache Software Foundation (ASF) under one
003 * or more contributor license agreements.  See the NOTICE file
004 * distributed with this work for additional information
005 * regarding copyright ownership.  The ASF licenses this file
006 * to you under the Apache License, Version 2.0 (the
007 * "License"); you may not use this file except in compliance
008 * with the License.  You may obtain a copy of the License at
009 *
010 *     http://www.apache.org/licenses/LICENSE-2.0
011 *
012 * Unless required by applicable law or agreed to in writing, software
013 * distributed under the License is distributed on an "AS IS" BASIS,
014 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
015 * See the License for the specific language governing permissions and
016 * limitations under the License.
017 */
018package org.apache.hadoop.hbase.hbtop.screen.help;
019
020import java.util.ArrayList;
021import java.util.Collections;
022import java.util.List;
023import java.util.Objects;
024
025import org.apache.yetus.audience.InterfaceAudience;
026
027
028/**
029 * Represents a description of a command that we can execute in the top screen.
030 */
031@InterfaceAudience.Private
032public class CommandDescription {
033
034  private final List<String> keys;
035  private final String description;
036
037  public CommandDescription(String key, String description) {
038    this(Collections.singletonList(Objects.requireNonNull(key)), description);
039  }
040
041  public CommandDescription(List<String> keys, String description) {
042    this.keys = Collections.unmodifiableList(new ArrayList<>(Objects.requireNonNull(keys)));
043    this.description = Objects.requireNonNull(description);
044  }
045
046  public List<String> getKeys() {
047    return keys;
048  }
049
050  public String getDescription() {
051    return description;
052  }
053}