Enum CommitIdGenerationMode

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

    public enum CommitIdGenerationMode
    extends java.lang.Enum<CommitIdGenerationMode>
    An enum to indicate how the git.commit.id property should be generated. See https://github.com/ktoso/maven-git-commit-id-plugin/issues/211 for further details.
    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      FLAT
      Indicator to generate a git.commit.id property (default)
      FULL
      Indicator to generate a git.commit.id.full property
    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static CommitIdGenerationMode valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static CommitIdGenerationMode[] 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

      • FLAT

        public static final CommitIdGenerationMode FLAT
        Indicator to generate a git.commit.id property (default)
    • Method Detail

      • values

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

        public static CommitIdGenerationMode 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