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.field;
019
020import java.util.Objects;
021import org.apache.yetus.audience.InterfaceAudience;
022
023
024/**
025 * Information about a field.
026 *
027 * This has a {@link Field} itself and additional information (e.g. {@code defaultLength} and
028 * {@code displayByDefault}). This additional information is different between the
029 * {@link org.apache.hadoop.hbase.hbtop.mode.Mode}s even when the field is the same. That's why the
030 * additional information is separated from {@link Field}.
031 */
032@InterfaceAudience.Private
033public class FieldInfo {
034  private final Field field;
035  private final int defaultLength;
036  private final boolean displayByDefault;
037
038  public FieldInfo(Field field, int defaultLength, boolean displayByDefault) {
039    this.field = Objects.requireNonNull(field);
040    this.defaultLength = defaultLength;
041    this.displayByDefault = displayByDefault;
042  }
043
044  public Field getField() {
045    return field;
046  }
047
048  public int getDefaultLength() {
049    return defaultLength;
050  }
051
052  public boolean isDisplayByDefault() {
053    return displayByDefault;
054  }
055}