iotdb-core/tsfile/src/main/java/org/apache/iotdb/tsfile/file/metadata/enums/MetadataIndexNodeType.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.iotdb.tsfile.file.metadata.enums;

import java.io.DataOutputStream;
import java.io.IOException;
import java.nio.ByteBuffer;

/**
 * The type of MetadataIndexNode.
 *
 * <p>INTERNAL_DEVICE: internal nodes of the index tree's device level LEAF_DEVICE: leaf nodes of
 * the index tree's device level, points to measurement level INTERNAL_MEASUREMENT: internal nodes
 * of the index tree's measurement level LEAF_MEASUREMENT: leaf nodes of the index tree's device
 * level, points to TimeseriesMetadata
 */
public enum MetadataIndexNodeType {
  /** INTERNAL_DEVICE. */
  INTERNAL_DEVICE((byte) 0),

  /** LEAF_DEVICE. */
  LEAF_DEVICE((byte) 1),

  /** INTERNAL_MEASUREMENT. */
  INTERNAL_MEASUREMENT((byte) 2),

  /** LEAF_MEASUREMENT. */
  LEAF_MEASUREMENT((byte) 3);

  private final byte type;

  MetadataIndexNodeType(byte type) {
    this.type = type;
  }

  /**
   * deserialize byte number.
   *
   * @param i byte number
   * @return MetadataIndexNodeType
   * @throws IllegalArgumentException illegal argument
   */
  public static MetadataIndexNodeType deserialize(byte i) {
    switch (i) {
      case 0:
        return MetadataIndexNodeType.INTERNAL_DEVICE;
      case 1:
        return MetadataIndexNodeType.LEAF_DEVICE;
      case 2:
        return MetadataIndexNodeType.INTERNAL_MEASUREMENT;
      case 3:
        return MetadataIndexNodeType.LEAF_MEASUREMENT;
      default:
        throw new IllegalArgumentException("Invalid input: " + i);
    }
  }

  public static MetadataIndexNodeType deserializeFrom(ByteBuffer buffer) {
    return deserialize(buffer.get());
  }

  public static int getSerializedSize() {
    return Byte.BYTES;
  }

  public void serializeTo(ByteBuffer byteBuffer) {
    byteBuffer.put(serialize());
  }

  public void serializeTo(DataOutputStream outputStream) throws IOException {
    outputStream.write(serialize());
  }

  /**
   * return a serialize child metadata index type.
   *
   * @return -enum type
   */
  public byte serialize() {
    return type;
  }
}