io.vertx.json.schema.Draft Maven / Gradle / Ivy

Go to download
/*
 * Copyright (c) 2011-2020 Contributors to the Eclipse Foundation
 *
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Public License 2.0 which is available at
 * http://www.eclipse.org/legal/epl-2.0, or the Apache License, Version 2.0
 * which is available at https://www.apache.org/licenses/LICENSE-2.0.
 *
 * SPDX-License-Identifier: EPL-2.0 OR Apache-2.0
 */
package io.vertx.json.schema;

import io.vertx.codegen.annotations.VertxGen;

/**
 * Json-Schema drafts.
 *
 * The enum does not explicitly define all known drafts but a selection of the most widely used ones and supported
 * in the implementation.
 *
 * @author Paulo Lopes
 */
@VertxGen
public enum Draft {
  /**
   * Draft 4 - http://json-schema.org/draft-04/schema#
   *
   * Usually used by OpenAPI 3.0
   */
  DRAFT4("http://json-schema.org/draft-04/schema#", 0),

  /**
   * Draft 7 - http://json-schema.org/draft-07/schema#
   *
   * Commonly used by many projects
   */
  DRAFT7("http://json-schema.org/draft-07/schema#", 1),

  /**
   * Draft 2019-09 - https://json-schema.org/draft/2019-09/schema
   *
   * Commonly used by many projects
   */
  DRAFT201909("https://json-schema.org/draft/2019-09/schema", 2),

  /**
   * Draft 2020-12 - https://json-schema.org/draft/2020-12/schema
   *
   * Usually used by OpenAPI 3.1
   */
  DRAFT202012("https://json-schema.org/draft/2020-12/schema", 3);

  private final String identifier;
  private final int order;

  Draft(String identifier, int order) {
    this.identifier = identifier;
    this.order = order;
  }

  /**
   * @return the identifier of the draft version.
   */
  public String getIdentifier() {
    return identifier;
  }

  /**
   * Converts a draft number to a {@link Draft} enum value.
   * @param string A draft number, e.g.: {@code [4|7|8|2019-09|2020-12]}
   * @return a Draft enum value
   */
  public static Draft from(String string) {
    if (string == null) {
      throw new IllegalArgumentException("Invalid draft: null");
    }
    switch (string) {
      case "4":
        return DRAFT4;
      case "7":
        return DRAFT7;
      case "8":
      case "2019-09":
        return DRAFT201909;
      case "2020-12":
        return DRAFT202012;
      default:
        throw new IllegalArgumentException("Unsupported draft: " + string);
    }
  }

  /**
   * Converts a draft identifier to a {@link Draft} enum value.
   * @param string The identifier (in URL format)
   * @return a Draft enum value
   */
  public static Draft fromIdentifier(String string) {
    if (string == null) {
      throw new IllegalArgumentException("Invalid draft identifier: null");
    }
    if(DRAFT4.identifier.equals(string)) {
      return DRAFT4;
    } else if(DRAFT7.identifier.equals(string)) {
      return DRAFT7;
    } else if(DRAFT201909.identifier.equals(string)) {
      return DRAFT201909;
    } else if(DRAFT202012.identifier.equals(string)) {
      return DRAFT202012;
    } else {
      throw new IllegalArgumentException("Unsupported draft identifier: " + string);
    }
  }

  /**
   * @param draft to check against
   * @return true if the draft instance was released after the draft provided.
   */
  public boolean isAfter(Draft draft) {
    return draft.order < this.order;
  }

  /**
   * @param draft to check against
   * @return true if the draft instance was released before the draft provided.
   */
  public boolean isBefore(Draft draft) {
    return draft.order > this.order;
  }

}