Package org.junit.jupiter.api.condition

Enum OS


  • @API(status=STABLE,
     since="5.1")
public enum OS
extends java.lang.Enum<OS>
    Enumeration of common operating systems used for testing Java applications.

    If the current operating system cannot be detected — for example, if the os.name JVM system property is undefined — then none of the constants defined in this enum will be considered to be the current operating system.

    Since:
    5.1
    See Also:
    EnabledOnOs, DisabledOnOs

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      LINUX
      Linux-based operating system.
      MAC
      Apple Macintosh operating system (e.g., macOS).
      OTHER
      An operating system other than LINUX, MAC, SOLARIS, or WINDOWS.
      SOLARIS
      Oracle Solaris operating system.
      WINDOWS
      Microsoft Windows operating system.

    • Method Summary

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

      • LINUX

        public static final OS LINUX
        Linux-based operating system.

      • MAC

        public static final OS MAC
        Apple Macintosh operating system (e.g., macOS).

      • SOLARIS

        public static final OS SOLARIS
        Oracle Solaris operating system.

      • WINDOWS

        public static final OS WINDOWS
        Microsoft Windows operating system.

    • Method Detail

      • values

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

      • valueOf

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

      • isCurrentOs

        public boolean isCurrentOs​()
        Returns:
        true if this OS is known to be the operating system on which the current JVM is executing