Enum Class WixToolsetVersion

java.lang.Object
java.lang.Enum<WixToolsetVersion>
com.github.wix_maven.WixToolsetVersion
All Implemented Interfaces:
Serializable, Comparable<WixToolsetVersion>, java.lang.constant.Constable

public enum WixToolsetVersion extends Enum<WixToolsetVersion>
Represents the WiX Toolset version family in use.

Detection is based on the wix.toolsPluginArtifactId Maven parameter:

  • wix-toolset (default) → V3
  • any artifact id containing "wix-toolset4", "wix-toolset5", "wix-toolset6", or starting with "wix4"V4_PLUS
  • Enum Constant Details

    • V3

      public static final WixToolsetVersion V3
      WiX Toolset v3 – separate executables: candle.exe, light.exe, etc.
    • V4_PLUS

      public static final WixToolsetVersion V4_PLUS
      WiX Toolset v4 or later – unified wix.exe CLI with subcommands.
  • Method Details

    • values

      public static WixToolsetVersion[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared
    • valueOf

      public static WixToolsetVersion valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name
      NullPointerException - if the argument is null
    • detect

      public static WixToolsetVersion detect(String toolsPluginArtifactId)
      Detect the toolset version from the Maven artifact id used for the tools package.
      Parameters:
      toolsPluginArtifactId - the value of wix.toolsPluginArtifactId
      Returns:
      V4_PLUS when the artifact id signals a v4+ toolset, otherwise V3