Enum ApiType

java.lang.Object
java.lang.Enum<ApiType>
com.ibm.wsspi.classloading.ApiType
All Implemented Interfaces:
Serializable, Comparable<ApiType>

public enum ApiType extends 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
    Proprietary APIs provided by non-IBM features.
    Proprietary APIs provided by IBM features.
    The standard APIs for any specifications supported by Liberty, e.g.
    Stable APIs -- These are third party APIs we have enough confidence in to expose by default, but are not fully spec APIs
    Proprietary APIs from third-party libraries which can be used in conjunction with features, e.g.
  • Method Summary

    Modifier and Type
    Method
    Description
    createApiTypeSet(String... apiTypes)
    Convert one or more comma-and-space-delimited api type strings into a single set of types
    static ApiType
     
     
    static ApiType
    Returns the enum constant of this type with the specified name.
    static ApiType[]
    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 Details

    • 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 Details

    • values

      public static ApiType[] 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 ApiType valueOf(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:
      IllegalArgumentException - if this enum type has no constant with the specified name
      NullPointerException - if the argument is null
    • fromString

      public static ApiType fromString(String value)
    • createApiTypeSet

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

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