OperatingSystemFamily (Gradle API 8.12)
Description: declaration: package: org.gradle.nativeplatform, class: OperatingSystemFamily

Package org.gradle.nativeplatform

# Class OperatingSystemFamily

java.lang.Object
org.gradle.nativeplatform.OperatingSystemFamily

All Implemented Interfaces:
  `Named`

public abstract class OperatingSystemFamily extends Object implements Named
Represents the operating system of a configuration. Typical operating system include Windows, Linux, and macOS. This interface allows the user to customize operating systems by implementing this interface.

Since:
  5.1

- ## Nested Class Summary

  ## Nested classes/interfaces inherited from interface org.gradle.api.Named

  `Named.Namer`

- ## Field Summary

  Fields
  Modifier and Type
  Field
  Description
  `static final String`
  `LINUX`
  The Linux operating system family.
  `static final String`
  `MACOS`
  The macOS operating system family.
  `static final Attribute<OperatingSystemFamily>`
  `OPERATING_SYSTEM_ATTRIBUTE`
  `static final String`
  `WINDOWS`
  The Windows operating system family.

- ## Constructor Summary

  Constructors
  Constructor
  Description
  `OperatingSystemFamily()`

- ## Method Summary

  Modifier and Type
  Method
  Description
  `abstract String`
  `getName()`
  The object's name.
  `boolean`
  `isLinux()`
  Is this the Linux operating system family?
  `boolean`
  `isMacOs()`
  Is this the macOS operating system family?
  `boolean`
  `isWindows()`
  Is this the Windows operating system family?

  ### Methods inherited from class java.lang.Object

  `clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

- ## Field Details

  - ### OPERATING_SYSTEM_ATTRIBUTE

    public static final Attribute<OperatingSystemFamily> OPERATING_SYSTEM_ATTRIBUTE

  - ### WINDOWS

    public static final String WINDOWS
    The Windows operating system family.
    See Also:
      - Constant Field Values

  - ### LINUX

    public static final String LINUX
    The Linux operating system family.
    See Also:
      - Constant Field Values

  - ### MACOS

    public static final String MACOS
    The macOS operating system family.
    See Also:
      - Constant Field Values

- ## Constructor Details

  - ### OperatingSystemFamily

    public OperatingSystemFamily()

- ## Method Details

  - ### getName

    @Input public abstract String getName()
    The object's name.

    Must be constant for the life of the object.

    Specified by:
      `getName` in interface `Named`
    Returns:
      The name. Never null.

  - ### isWindows

    public boolean isWindows()
    Is this the Windows operating system family?

  - ### isLinux

    public boolean isLinux()
    Is this the Linux operating system family?

  - ### isMacOs

    public boolean isMacOs()
    Is this the macOS operating system family?