Package velox.api.layer1.annotations

Enum Layer1ApiVersionValue

java.lang.Object
java.lang.Enum<Layer1ApiVersionValue>
velox.api.layer1.annotations.Layer1ApiVersionValue
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<Layer1ApiVersionValue>, java.lang.constant.Constable
public enum Layer1ApiVersionValue
extends java.lang.Enum<Layer1ApiVersionValue>
List of API versions. If you are writing a new module, you typically want the latest one available in the lowest Bookmap that you are targeting. Easiest way to check would be to install that version and see what is the last value in this enum. If no such enum exists this means you have picked pre-compatibility-system version, which is not recommended. Compatibility system was added in version 7.0 during beta stage.
Only breaking changes are listed in comments. New features can be added at any point without incrementing API version (especially while in alpha/beta), so there is no guarantee that older build will run with indicator intended for newer one.

  • Nested Class Summary

    Nested classes/interfaces inherited from class java.lang.Enum

    java.lang.Enum.EnumDesc<E extends java.lang.Enum<E>>

  • Enum Constant Summary

    Enum Constants 
    Enum Constant Description
    VERSION0
    API right before compatibility system was introduced.
    VERSION1
    Development started around 2018-06-12 in version 7.0.
    VERSION2
    Development started around 2018-11-20 in version 7.0.

  • Method Summary

    Modifier and Type Method Description
    static Layer1ApiVersionValue getHighestVersion()  
    int getNumericValue()  
    static Layer1ApiVersionValue valueOf​(int numericValue)
    Returns the enum constant of this type with the specified name.
    static Layer1ApiVersionValue valueOf​(java.lang.String name)
    Returns the enum constant of this type with the specified name.
    static Layer1ApiVersionValue[] values()
    Returns an array containing the constants of this enum type, in the order they are declared.

    Methods inherited from class java.lang.Enum

    clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

  • Enum Constant Details

  • Method Details

    • values

      public static Layer1ApiVersionValue[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      Returns:
      an array containing the constants of this enum type, in the order they are declared

    • valueOf

      public static Layer1ApiVersionValue valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
      java.lang.NullPointerException - if the argument is null

    • getNumericValue

      public int getNumericValue()

    • getHighestVersion

      public static Layer1ApiVersionValue getHighestVersion()

    • valueOf

      public static Layer1ApiVersionValue valueOf​(int numericValue)
      Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
      Parameters:
      numericValue - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
      java.lang.NullPointerException - if the argument is null