Enum ApiType

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<ApiType>

    public enum ApiType
    extends java.lang.Enum<ApiType>
    An Api Type is a grouping of packages that can be accessed by applications. The grouping represents a coarse-grained control structure for use with JEE. It is not needed for OSGi artefacts since they have a finer-grained control structure built in already.
    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      API
      Proprietary APIs provided by non-IBM features.
      IBMAPI
      Proprietary APIs provided by IBM features.
      SPEC
      The standard APIs for any specifications supported by Liberty, e.g.
      STABLE
      Stable APIs -- These are third party APIs we have enough confidence in to expose by default, but are not fully spec APIs
      THIRDPARTY
      Proprietary APIs from third-party libraries which can be used in conjunction with features, e.g.
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      static java.util.EnumSet<ApiType> createApiTypeSet​(java.lang.String... apiTypes)
      Convert one or more comma-and-space-delimited api type strings into a single set of types
      static ApiType fromString​(java.lang.String value)  
      java.lang.String toString()  
      static ApiType valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static ApiType[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      • Methods inherited from class java.lang.Enum

        compareTo, equals, getDeclaringClass, hashCode, name, ordinal, valueOf
      • Methods inherited from class java.lang.Object

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

      • SPEC

        public static final ApiType SPEC
        The standard APIs for any specifications supported by Liberty, e.g. javax.servlet.http
      • IBMAPI

        public static final ApiType IBMAPI
        Proprietary APIs provided by IBM features.
      • API

        public static final ApiType API
        Proprietary APIs provided by non-IBM features.
      • THIRDPARTY

        public static final ApiType THIRDPARTY
        Proprietary APIs from third-party libraries which can be used in conjunction with features, e.g. the Wink APIs for use with Liberty's JAX-RS support.
      • STABLE

        public static final ApiType STABLE
        Stable APIs -- These are third party APIs we have enough confidence in to expose by default, but are not fully spec APIs
    • Method Detail

      • values

        public static ApiType[] 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 (ApiType c : ApiType.values())
            System.out.println(c);
        
        Returns:
        an array containing the constants of this enum type, in the order they are declared
      • valueOf

        public static ApiType 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
      • fromString

        public static ApiType fromString​(java.lang.String value)
      • createApiTypeSet

        public static java.util.EnumSet<ApiType> createApiTypeSet​(java.lang.String... apiTypes)
        Convert one or more comma-and-space-delimited api type strings into a single set of types
      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Enum<ApiType>