MavenVersion.java

package com.soebes.itf.jupiter.extension;

/*
 * 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.
 */

import org.apiguardian.api.API;

import static com.soebes.itf.jupiter.extension.MavenVersionComparator.of;
import static com.soebes.itf.jupiter.extension.Preconditions.requireNotEmpty;
import static com.soebes.itf.jupiter.extension.Preconditions.requireNotNull;
import static org.apiguardian.api.API.Status.EXPERIMENTAL;

/**
 * @author Karl Heinz Marbaise
 */
@API(status = EXPERIMENTAL, since = "0.1.0")
public enum MavenVersion {
  /**
   * @deprecated Please use {@link #ANY} instead. Will be removed with Release 0.14.0
   */
  @Deprecated
  UNKNOWN(of()),
  /**
   * Represent any Maven version.
   */
  ANY(of()),
  /**
   * Apache Maven Version 3.0.X
   * Do not use them anymore, because Maven 3.0.X is very old!
   */
  @Deprecated
  M3_0(of(3,0)),
  @Deprecated
  M3_0_5(of(3,0,5)),
  /**
   * Apache Maven Version 3.1.X
   * Do not use them anymore, because Maven 3.0.X is very old!
   */
  @Deprecated
  M3_1(of(3,1)),
  @Deprecated
  M3_1_0(of(3,1,0)),
  @Deprecated
  M3_1_1(of(3,1,1)),
  /**
   * Apache Maven Version 3.2.X
   * Do not use them anymore, because Maven 3.0.X is very old!
   */
  @Deprecated
  M3_2(of(3,2)),
  @Deprecated
  M3_2_1(of(3,2,1)),
  @Deprecated
  M3_2_2(of(3,2,2)),
  @Deprecated
  M3_2_3(of(3,2,3)),
  @Deprecated
  M3_2_5(of(3,2,5)),
  /**
   * Apache Maven Version 3.3.X
   * Do not use them anymore, because Maven 3.0.X is very old!
   */
  @Deprecated
  M3_3(of(3,3)),
  @Deprecated
  M3_3_1(of(3,3,1)),
  @Deprecated
  M3_3_3(of(3,3,3)),
  @Deprecated
  M3_3_9(of(3,3,9)),
  /**
   * Apache Maven Version 3.5.X
   * Do not use them anymore, because Maven 3.0.X is very old!
   */
  @Deprecated
  M3_5(of(3,5)),
  @Deprecated
  M3_5_0(of(3,5,0)),
  @Deprecated
  M3_5_2(of(3,5,2)),
  @Deprecated
  M3_5_3(of(3,5,3)),
  @Deprecated
  M3_5_4(of(3,5,4)),
  /**
   * Apache Maven Version 3.6.X
   * Do not use them anymore, because Maven 3.0.X is very old!
   */
  M3_6(of(3,6)),
  M3_6_0(of(3,6,0)),
  M3_6_1(of(3,6,1)),
  M3_6_2(of(3,6,2)),
  M3_6_3(of(3,6,3)),
  /**
   * Apache Maven Version 3.8.X
   */
  M3_8(of(3,8)),
  M3_8_1(of(3,8,1)),
  M3_8_2(of(3,8,2)),
  M3_8_3(of(3,8,3)),
  M3_8_4(of(3,8,4)),
  M3_8_5(of(3,8,5)),
  M3_8_6(of(3,8,6)),
  M3_8_7(of(3,8,7)),
  M3_8_8(of(3,8,8)),
  /**
   * Apache Maven Version 3.9.X
   */
  M3_9(of(3,9)),
  M3_9_0(of(3,9,0)),
  M3_9_1(of(3,9,1)),
  M3_9_2(of(3,9,2)),
  M3_9_3(of(3,9,3)),
  M3_9_4(of(3,9,4)),
  M3_9_5(of(3,9,5)),
  M3_9_6(of(3,9,6)),
  /**
   * Apache Maven Version 4.0.X
   */
  M4_0(of(4,0)),
  M4_0_0(of(4,0,0)),
  M4_0_1(of(4,0,1));

  private static final MavenVersionComparator CURRENT_MAVEN_VERSION = determineCurrentVersion();

  private final MavenVersionComparator versionComparator;

  MavenVersion(MavenVersionComparator versionComparator) {
    this.versionComparator = versionComparator;
  }

  private static MavenVersionComparator determineCurrentVersion() {
    String currentVersion = requireNotNull(System.getProperty("maven.version"), "JVM system property 'maven.version' is empty.");
    requireNotEmpty(currentVersion, "JVM system property 'maven.version' is empty. The maven version can not being detected.");
    return MavenVersionParser.parseVersion(currentVersion);
  }

  /**
   * @return {@code true} if <em>this</em> {@link MavenVersion} is known to be the Maven version for the currently being
   * executed Maven version.
   */
  public boolean isCurrentVersion() {
    return this.getVersion().compareTo(CURRENT_MAVEN_VERSION) == 0;
  }

  public MavenVersionComparator getVersion() {
    return versionComparator;
  }
}