hbase-server/src/main/java/org/apache/hadoop/hbase/TableDescriptor.java

/**
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.apache.hadoop.hbase;

import com.google.protobuf.InvalidProtocolBufferException;
import java.io.IOException;
import org.apache.hadoop.hbase.classification.InterfaceAudience;
import org.apache.hadoop.hbase.client.TableState;
import org.apache.hadoop.hbase.exceptions.DeserializationException;
import org.apache.hadoop.hbase.protobuf.ProtobufUtil;
import org.apache.hadoop.hbase.protobuf.generated.HBaseProtos;

/**
 * Class represents table state on HDFS.
 */
@InterfaceAudience.Private
public class TableDescriptor {
  private HTableDescriptor hTableDescriptor;
  private TableState.State tableState;

  /**
   * Creates TableDescriptor with all fields.
   * @param hTableDescriptor HTableDescriptor to use
   * @param tableState table state
   */
  public TableDescriptor(HTableDescriptor hTableDescriptor,
      TableState.State tableState) {
    this.hTableDescriptor = hTableDescriptor;
    this.tableState = tableState;
  }

  /**
   * Creates TableDescriptor with Enabled table.
   * @param hTableDescriptor HTableDescriptor to use
   */
  public TableDescriptor(HTableDescriptor hTableDescriptor) {
    this(hTableDescriptor, TableState.State.ENABLED);
  }

  /**
   * Associated HTableDescriptor
   * @return instance of HTableDescriptor
   */
  public HTableDescriptor getHTableDescriptor() {
    return hTableDescriptor;
  }

  public void setHTableDescriptor(HTableDescriptor hTableDescriptor) {
    this.hTableDescriptor = hTableDescriptor;
  }

  public TableState.State getTableState() {
    return tableState;
  }

  public void setTableState(TableState.State tableState) {
    this.tableState = tableState;
  }

  /**
   * Convert to PB.
   */
  public HBaseProtos.TableDescriptor convert() {
    return HBaseProtos.TableDescriptor.newBuilder()
        .setSchema(hTableDescriptor.convert())
        .setState(tableState.convert())
        .build();
  }

  /**
   * Convert from PB
   */
  public static TableDescriptor convert(HBaseProtos.TableDescriptor proto) {
    HTableDescriptor hTableDescriptor = HTableDescriptor.convert(proto.getSchema());
    TableState.State state = TableState.State.convert(proto.getState());
    return new TableDescriptor(hTableDescriptor, state);
  }

  /**
   * @return This instance serialized with pb with pb magic prefix
   * @see #parseFrom(byte[])
   */
  public byte [] toByteArray() {
    return ProtobufUtil.prependPBMagic(convert().toByteArray());
  }

  /**
   * @param bytes A pb serialized {@link TableDescriptor} instance with pb magic prefix
   * @see #toByteArray()
   */
  public static TableDescriptor parseFrom(final byte [] bytes)
      throws DeserializationException, IOException {
    if (!ProtobufUtil.isPBMagicPrefix(bytes)) {
      throw new DeserializationException("Expected PB encoded TableDescriptor");
    }
    int pblen = ProtobufUtil.lengthOfPBMagic();
    HBaseProtos.TableDescriptor.Builder builder = HBaseProtos.TableDescriptor.newBuilder();
    HBaseProtos.TableDescriptor ts;
    try {
      ts = builder.mergeFrom(bytes, pblen, bytes.length - pblen).build();
    } catch (InvalidProtocolBufferException e) {
      throw new DeserializationException(e);
    }
    return convert(ts);
  }

  @Override
  public boolean equals(Object o) {
    if (this == o) {
      return true;
    }
    if (o == null || getClass() != o.getClass()) {
      return false;
    }

    TableDescriptor that = (TableDescriptor) o;

    if (hTableDescriptor != null ?
        !hTableDescriptor.equals(that.hTableDescriptor) :
        that.hTableDescriptor != null){
      return false;
    }
    if (tableState != that.tableState) {
      return false;
    }
    return true;
  }

  @Override
  public int hashCode() {
    int result = hTableDescriptor != null ? hTableDescriptor.hashCode() : 0;
    result = 31 * result + (tableState != null ? tableState.hashCode() : 0);
    return result;
  }

  @Override
  public String toString() {
    return "TableDescriptor{" +
        "hTableDescriptor=" + hTableDescriptor +
        ", tableState=" + tableState +
        '}';
  }
}