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.terminal;
019
020import edu.umd.cs.findbugs.annotations.Nullable;
021import java.io.Closeable;
022import org.apache.yetus.audience.InterfaceAudience;
023
024/**
025 * The terminal interface that is an abstraction of terminal screen.
026 */
027@InterfaceAudience.Private
028public interface Terminal extends Closeable {
029  void clear();
030
031  void refresh();
032
033  @Nullable
034  TerminalSize getSize();
035
036  @Nullable
037  TerminalSize doResizeIfNecessary();
038
039  @Nullable
040  KeyPress pollKeyPress();
041
042  CursorPosition getCursorPosition();
043
044  void setCursorPosition(int column, int row);
045
046  void hideCursor();
047
048  TerminalPrinter getTerminalPrinter(int startRow);
049}