Enum SpecMode

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

    public enum SpecMode
    extends java.lang.Enum<SpecMode>
    API specification modes. Value of API specification mode is passed as specMode configuration property.
    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      JAKARTA
      Jakarta EE4J spec mode for jakarta value of specMode property.
      JAVAEE
      Java EE spec mode for javaee value of specMode property (default).
    • Field Summary

      Fields 
      Modifier and Type Field Description
      static int COUNT
      Spec mode enumeration elements count.
      private java.lang.String name
      Name of spec plugin mode.
      private java.lang.String prefix
      Group ID and package prefix for this mode.
      private static java.util.Map<java.lang.String,​SpecMode> STR_TO_SPECMODE_MAP
      Spec mode name to SpecMode instance conversion map.
    • Constructor Summary

      Constructors 
      Modifier Constructor Description
      private SpecMode​(java.lang.String modeName, java.lang.String groupIdPrefix)
      Creates an instance of spec plugin mode.
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      static SpecMode getSpecMode​(java.lang.String name)
      Get spec plugin mode with corresponding name.
      java.lang.String grePrefix()
      Returns group ID and package prefix for this mode.
      static SpecMode valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static SpecMode[] 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

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

      • COUNT

        public static final int COUNT
        Spec mode enumeration elements count.
      • STR_TO_SPECMODE_MAP

        private static final java.util.Map<java.lang.String,​SpecMode> STR_TO_SPECMODE_MAP
        Spec mode name to SpecMode instance conversion map.
      • name

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

        private final java.lang.String prefix
        Group ID and package prefix for this mode. Including '.' at the end.
    • Constructor Detail

      • SpecMode

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

      • values

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

        public static SpecMode 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
      • getSpecMode

        public static SpecMode getSpecMode​(java.lang.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 java.lang.String grePrefix()
        Returns group ID and package prefix for this mode. Including '.' at the end.
        Returns:
        group ID and package prefix for this mode