/*
 * 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.ozone.container.common;

/**
 * Layout version which describes information about the layout version
 * on the datanode volume.
 */
public final class HDDSVolumeLayoutVersion {

  // We will just be normal and use positive counting numbers for versions.
  private static final HDDSVolumeLayoutVersion[] VERSION_INFOS =
      {new HDDSVolumeLayoutVersion(1, "HDDS Datanode LayOut Version 1")};

  private final String description;
  private final int version;

  /**
   * Never created outside this class.
   *
   * @param description -- description
   * @param version     -- version number
   */
  private HDDSVolumeLayoutVersion(int version, String description) {
    this.description = description;
    this.version = version;
  }

  /**
   * Returns all versions.
   *
   * @return Version info array.
   */
  public static HDDSVolumeLayoutVersion[] getAllVersions() {
    return VERSION_INFOS.clone();
  }

  /**
   * Returns the latest version.
   *
   * @return versionInfo
   */
  public static HDDSVolumeLayoutVersion getLatestVersion() {
    return VERSION_INFOS[VERSION_INFOS.length - 1];
  }

  /**
   * Return description.
   *
   * @return String
   */
  public String getDescription() {
    return description;
  }

  /**
   * Return the version.
   *
   * @return int.
   */
  public int getVersion() {
    return version;
  }

}
