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.field;
19
20 import java.util.Objects;
21
22 import org.apache.hadoop.hbase.classification.InterfaceAudience;
23
24 /**
25 * Information about a field.
26 *
27 * This has a {@link Field} itself and additional information (e.g. {@code defaultLength} and
28 * {@code displayByDefault}). This additional information is different between the
29 * {@link org.apache.hadoop.hbase.hbtop.mode.Mode}s even when the field is the same. That's why the
30 * additional information is separated from {@link Field}.
31 */
32 @InterfaceAudience.Private
33 public class FieldInfo {
34 private final Field field;
35 private final int defaultLength;
36 private final boolean displayByDefault;
37
38 public FieldInfo(Field field, int defaultLength, boolean displayByDefault) {
39 this.field = Objects.requireNonNull(field);
40 this.defaultLength = defaultLength;
41 this.displayByDefault = displayByDefault;
42 }
43
44 public Field getField() {
45 return field;
46 }
47
48 public int getDefaultLength() {
49 return defaultLength;
50 }
51
52 public boolean isDisplayByDefault() {
53 return displayByDefault;
54 }
55 }