content: /*
   ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~
   ~                                                                               ~
   ~ The MIT License (MIT)                                                         ~
   ~                                                                               ~
   ~ Copyright (c) 2015-2025 miaixz.org OSHI and other contributors.               ~
   ~                                                                               ~
   ~ Permission is hereby granted, free of charge, to any person obtaining a copy  ~
   ~ of this software and associated documentation files (the "Software"), to deal ~
   ~ in the Software without restriction, including without limitation the rights  ~
   ~ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell     ~
   ~ copies of the Software, and to permit persons to whom the Software is         ~
   ~ furnished to do so, subject to the following conditions:                      ~
   ~                                                                               ~
   ~ The above copyright notice and this permission notice shall be included in    ~
   ~ all copies or substantial portions of the Software.                           ~
   ~                                                                               ~
   ~ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR    ~
   ~ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,      ~
   ~ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE   ~
   ~ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER        ~
   ~ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, ~
   ~ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN     ~
   ~ THE SOFTWARE.                                                                 ~
   ~                                                                               ~
   ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~
  */
  package org.miaixz.bus.health.builtin.hardware;
  
  import java.util.Collections;
  import java.util.List;
  
  import org.miaixz.bus.core.lang.annotation.ThreadSafe;
  
  /**
   * A hardware abstraction layer. Provides access to hardware items such as processors, memory, battery, and disks.
   *
   * @author Kimi Liu
   * @since Java 17+
   */
  @ThreadSafe
  public interface HardwareAbstractionLayer {
  
      /**
       * Instantiates a {@link ComputerSystem} object. This represents the physical hardware, including components such as
       * BIOS/Firmware and a motherboard, logic board, etc.
       *
       * @return a {@link ComputerSystem} object.
       */
      ComputerSystem getComputerSystem();
  
      /**
       * Instantiates a {@link CentralProcessor} object. This represents one or more Logical CPUs.
       *
       * @return A {@link CentralProcessor} object.
       */
      CentralProcessor getProcessor();
  
      /**
       * Instantiates a {@link GlobalMemory} object.
       *
       * @return A memory object.
       */
      GlobalMemory getMemory();
  
      /**
       * Instantiates a list of {@link PowerSource} objects, representing batteries, etc.
       *
       * @return A list of PowerSource objects or an empty list if none are present.
       */
      List<PowerSource> getPowerSources();
  
      /**
       * Instantiates a list of {@link HWDiskStore} objects, representing physical hard disks or other similar storage
       * devices.
       *
       * @return A list of HWDiskStore objects or an empty list if none are present.
       */
      List<HWDiskStore> getDiskStores();
  
      /**
       * Instantiates a list of {@link LogicalVolumeGroup} objects, representing a storage pool or group of devices,
       * partitions, volumes, or other implementation specific means of file storage.
       * <p>
       * If not yet implemented or if logical volume groups do not exist, returns an empty list.
       * <p>
       * Currently implemented for Linux (LVM2), macOS (Core Storage), and Windows (Storage Spaces).
       *
       * @return A list of {@link LogicalVolumeGroup} objects or an empty list if none are present.
       */
      default List<LogicalVolumeGroup> getLogicalVolumeGroups() {
          return Collections.emptyList();
      }
  
      /**
       * Gets a list of non-local {@link NetworkIF} objects, representing a network interface. The list excludes local
       * interfaces.
       *
       * @return A list of {@link NetworkIF} objects representing the interfaces
       */
      List<NetworkIF> getNetworkIFs();
  
      /**
       * Gets a list {@link NetworkIF} objects, representing a network interface.
       *
       * @param includeLocalInterfaces whether to include local interfaces (loopback or no hardware address) in the result
       * @return A list of {@link NetworkIF} objects representing the interfaces
       */
      List<NetworkIF> getNetworkIFs(boolean includeLocalInterfaces);
  
      /**
       * Instantiates a list of {@link Display} objects, representing monitors or other video output devices.
       *
       * @return A list of Display objects or an empty list if none are present.
       */
      List<Display> getDisplays();
  
      /**
       * Instantiates a {@link Sensors} object, representing CPU temperature and fan speed.
       *
       * @return A Sensors object
       */
      Sensors getSensors();
  
      /**
       * Instantiates a list of {@link UsbDevice} objects, representing devices connected via a usb port (including
       * internal devices).
       * <p>
       * If the value of {@code tree} is true, the top level devices returned from this method are the USB Controllers;
       * connected hubs and devices in its device tree share that controller's bandwidth. If the value of {@code tree} is
       * false, USB devices (not controllers) are listed in a single flat list.
       *
       * @param tree If {@code true}, returns devices connected to the existing device, accessible via
       *             {@link UsbDevice#getConnectedDevices()}. If {@code false} returns devices as a flat list with no
       *             connected device information.
       * @return A list of UsbDevice objects representing (optionally) the USB Controllers and devices connected to them,
       *         or an empty list if none are present
       */
      List<UsbDevice> getUsbDevices(boolean tree);
  
      /**
       * Instantiates a list of {@link SoundCard} objects, representing the Sound cards.
       *
       * @return A list of SoundCard objects or an empty list if none are present.
       */
      List<SoundCard> getSoundCards();
  
      /**
       * Instantiates a list of {@link GraphicsCard} objects, representing the Graphics cards.
       *
       * @return A list of objects or an empty list if none are present.
       */
      List<GraphicsCard> getGraphicsCards();
  
  }
  