View Javadoc

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.terminal;
19  
20  import edu.umd.cs.findbugs.annotations.Nullable;
21  import java.io.Closeable;
22  
23  import org.apache.hadoop.hbase.classification.InterfaceAudience;
24  
25  /**
26   * The terminal interface that is an abstraction of terminal screen.
27   */
28  @InterfaceAudience.Private
29  public interface Terminal extends Closeable {
30    void clear();
31    void refresh();
32    @Nullable TerminalSize getSize();
33    @Nullable TerminalSize doResizeIfNecessary();
34    @Nullable KeyPress pollKeyPress();
35    CursorPosition getCursorPosition();
36    void setCursorPosition(int column, int row);
37    void hideCursor();
38    TerminalPrinter getTerminalPrinter(int startRow);
39  }