Package org.junit.jupiter.api.condition

Enum OS

java.lang.Object
java.lang.Enum<OS>
org.junit.jupiter.api.condition.OS
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<OS>, java.lang.constant.Constable
@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:
AIX, LINUX, MAC, SOLARIS, WINDOWS, OTHER, EnabledOnOs, DisabledOnOs

  • Nested Class Summary

    Nested classes/interfaces inherited from class java.lang.Enum

    java.lang.Enum.EnumDesc<E extends java.lang.Enum<E>>

  • Enum Constant Summary

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

  • Method Summary

    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, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

  • Enum Constant Details

    • AIX

      @API(status=STABLE, since="5.3") public static final OS AIX
      IBM AIX operating system.
      Since:
      5.3

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

    • OTHER

      public static final OS OTHER
      An operating system other than AIX, LINUX, MAC, SOLARIS, or WINDOWS.

  • Method Details

    • values

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