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