Enum SpecMode

java.lang.Object
java.lang.Enum<SpecMode>
org.glassfish.spec.SpecMode
All Implemented Interfaces:
Serializable, Comparable<SpecMode>, java.lang.constant.Constable
public enum SpecMode extends Enum<SpecMode>
API specification modes. Value of API specification mode is passed as specMode configuration property.

  • Enum Constant Details

    • JAVAEE

      public static final SpecMode JAVAEE
      Java EE spec mode for javaee value of specMode property (default).

    • JAKARTA

      public static final SpecMode JAKARTA
      Jakarta EE4J spec mode for jakarta value of specMode property.

  • Field Details

    • COUNT

      public static final int COUNT
      Spec mode enumeration elements count.

    • STR_TO_SPECMODE_MAP

      private static final Map<String,SpecMode> STR_TO_SPECMODE_MAP
      Spec mode name to SpecMode instance conversion map.

    • name

      private final String name
      Name of spec plugin mode. Value of name.toLowerCase() must match corresponding specMode lowercase value from pom.xml.

    • prefix

      private final String prefix
      Group ID and package prefix for this mode. Including '.' at the end.

  • Constructor Details

    • SpecMode

      private SpecMode(String modeName, String groupIdPrefix)
      Creates an instance of spec plugin mode.
      Parameters:
      modeName - name of spec plugin mode
      groupIdPrefix - group ID prefix for specific mode

  • Method Details

    • values

      public static SpecMode[] 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 SpecMode 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

    • getSpecMode

      public static SpecMode getSpecMode(String name)
      Get spec plugin mode with corresponding name.
      Parameters:
      name - name of spec plugin mode
      Returns:
      spec plugin mode with corresponding name or default JAVAEE value when no appropriate value was found.

    • grePrefix

      public String grePrefix()
      Returns group ID and package prefix for this mode. Including '.' at the end.
      Returns:
      group ID and package prefix for this mode