Package com.io7m.waxmill.machines

Class WXMDevicePassthru

java.lang.Object
com.io7m.waxmill.machines.WXMDevicePassthru
All Implemented Interfaces:
WXMDeviceType, WXMDeviceType.WXMDevicePassthruType
public final class WXMDevicePassthru
extends java.lang.Object
implements WXMDeviceType.WXMDevicePassthruType
A PCI passthru device.

  • Method Details

    • comment

      public java.lang.String comment()
      Specified by:
      comment in interface WXMDeviceType
      Specified by:
      comment in interface WXMDeviceType.WXMDevicePassthruType
      Returns:
      The value of the comment attribute

    • deviceSlot

      public WXMDeviceSlot deviceSlot()
      Specified by:
      deviceSlot in interface WXMDeviceType
      Specified by:
      deviceSlot in interface WXMDeviceType.WXMDevicePassthruType
      Returns:
      The value of the deviceSlot attribute

    • hostPCISlot

      public WXMDeviceSlot hostPCISlot()
      Specified by:
      hostPCISlot in interface WXMDeviceType.WXMDevicePassthruType
      Returns:
      The slot containing the host PCI devices

    • withComment

      public final WXMDevicePassthru withComment​(java.lang.String value)
      Copy the current immutable object by setting a value for the comment attribute. An equals check used to prevent copying of the same value by returning this.
      Parameters:
      value - A new value for comment
      Returns:
      A modified copy of the this object

    • withDeviceSlot

      public final WXMDevicePassthru withDeviceSlot​(WXMDeviceSlot value)
      Copy the current immutable object by setting a value for the deviceSlot attribute. A shallow reference equality check is used to prevent copying of the same value by returning this.
      Parameters:
      value - A new value for deviceSlot
      Returns:
      A modified copy of the this object

    • withHostPCISlot

      public final WXMDevicePassthru withHostPCISlot​(WXMDeviceSlot value)
      Copy the current immutable object by setting a value for the hostPCISlot attribute. A shallow reference equality check is used to prevent copying of the same value by returning this.
      Parameters:
      value - A new value for hostPCISlot
      Returns:
      A modified copy of the this object

    • equals

      public boolean equals​(java.lang.Object another)
      This instance is equal to all instances of WXMDevicePassthru that have equal attribute values.
      Overrides:
      equals in class java.lang.Object
      Returns:
      true if this is equal to another instance

    • hashCode

      public int hashCode()
      Computes a hash code from attributes: comment, deviceSlot, hostPCISlot.
      Overrides:
      hashCode in class java.lang.Object
      Returns:
      hashCode value

    • toString

      public java.lang.String toString()
      Prints the immutable value WXMDevicePassthru with attribute values.
      Overrides:
      toString in class java.lang.Object
      Returns:
      A string representation of the value

    • copyOf

      public static WXMDevicePassthru copyOf​(WXMDeviceType.WXMDevicePassthruType instance)
      Creates an immutable copy of a WXMDeviceType.WXMDevicePassthruType value. Uses accessors to get values to initialize the new immutable instance. If an instance is already immutable, it is returned as is.
      Parameters:
      instance - The instance to copy
      Returns:
      A copied immutable WXMDevicePassthru instance

    • builder

      public static WXMDevicePassthru.Builder builder()
      Creates a builder for WXMDevicePassthru. 
       WXMDevicePassthru.builder()
    .setComment(String) // optional comment
    .setDeviceSlot(com.io7m.waxmill.machines.WXMDeviceSlot) // required deviceSlot
    .setHostPCISlot(com.io7m.waxmill.machines.WXMDeviceSlot) // required hostPCISlot
    .build();
      Returns:
      A new WXMDevicePassthru builder