Enum API.Status

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<API.Status>
    Enclosing class:
    API

    public static enum API.Status
    extends java.lang.Enum<API.Status>
    Indicates the status of an API element and therefore its level of stability as well.
    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      DEPRECATED
      Should no longer be used.
      EXPERIMENTAL
      Intended for new, experimental features where the publisher of the API is looking for feedback.
      INTERNAL
      Must not be used by any external code.
      MAINTAINED
      Intended for features that will not be changed in a backwards-incompatible way for at least the next minor release of the current major version.
      STABLE
      Intended for features that will not be changed in a backwards-incompatible way in the current major version.
    • Constructor Summary

      Constructors 
      Modifier Constructor Description
      private Status()  
    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static API.Status valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static API.Status[] 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, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait
    • Enum Constant Detail

      • INTERNAL

        public static final API.Status INTERNAL
        Must not be used by any external code. Might be removed without prior notice.
      • DEPRECATED

        public static final API.Status DEPRECATED
        Should no longer be used. Might disappear in the next minor release.

        This status is usually used in combination with the standard annotation @Deprecated because that annotation is recognized by IDEs and the compiler. However, there are also cases where this status can be used on its own, for example when transitioning a MAINTAINED feature to an INTERNAL one.

      • EXPERIMENTAL

        public static final API.Status EXPERIMENTAL
        Intended for new, experimental features where the publisher of the API is looking for feedback.

        Use with caution. Might be promoted to MAINTAINED or STABLE in the future, but might also be removed without prior notice.

      • MAINTAINED

        public static final API.Status MAINTAINED
        Intended for features that will not be changed in a backwards-incompatible way for at least the next minor release of the current major version. If scheduled for removal, such a feature will be demoted to DEPRECATED first.
      • STABLE

        public static final API.Status STABLE
        Intended for features that will not be changed in a backwards-incompatible way in the current major version.
    • Constructor Detail

      • Status

        private Status()
    • Method Detail

      • values

        public static API.Status[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
        for (API.Status c : API.Status.values())
            System.out.println(c);
        
        Returns:
        an array containing the constants of this enum type, in the order they are declared
      • valueOf

        public static API.Status 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