Package com.io7m.waxmill.xml.vm.v1

# Class WXM1BSDBootDevice

java.lang.Object
com.io7m.waxmill.xml.vm.v1.WXM1BSDBootDevice

All Implemented Interfaces:
  `WXM1BSDBootDeviceType`

    public final class WXM1BSDBootDevice
    extends java.lang.Object
    implements WXM1BSDBootDeviceType

Immutable implementation of `WXM1BSDBootDeviceType`.

Use the builder to create immutable instances: `WXM1BSDBootDevice.builder()`.

- ## Nested Class Summary

  Nested Classes
  Modifier and Type | Class | Description
  --- | --- | ---
  `static class` | `WXM1BSDBootDevice.Builder` | Builds instances of type `WXM1BSDBootDevice`.

- ## Method Summary

  Modifier and Type | Method | Description
  --- | --- | ---
  `static WXM1BSDBootDevice.Builder` | `builder()` | Creates a builder for `WXM1BSDBootDevice`.
  `static WXM1BSDBootDevice` | `copyOf​(WXM1BSDBootDeviceType instance)` | Creates an immutable copy of a `WXM1BSDBootDeviceType` value.
  `WXMDeviceSlot` | `deviceSlot()` |
  `boolean` | `equals​(java.lang.Object another)` | This instance is equal to all instances of `WXM1BSDBootDevice` that have equal attribute values.
  `int` | `hashCode()` | Computes a hash code from attributes: `deviceSlot`, `kernelPath`.
  `java.nio.file.Path` | `kernelPath()` |
  `java.lang.String` | `toString()` | Prints the immutable value `WXM1BSDBootDevice` with attribute values.
  `WXM1BSDBootDevice` | `withDeviceSlot​(WXMDeviceSlot value)` | Copy the current immutable object by setting a value for the `deviceSlot` attribute.
  `WXM1BSDBootDevice` | `withKernelPath​(java.nio.file.Path value)` | Copy the current immutable object by setting a value for the `kernelPath` attribute.

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

  `clone, finalize, getClass, notify, notifyAll, wait, wait, wait`

- ## Method Details

  - ### deviceSlot

    public WXMDeviceSlot deviceSlot()
    Specified by:
      `deviceSlot` in interface `WXM1BSDBootDeviceType`
    Returns:
      The value of the `deviceSlot` attribute

  - ### kernelPath

    public java.nio.file.Path kernelPath()
    Specified by:
      `kernelPath` in interface `WXM1BSDBootDeviceType`
    Returns:
      The value of the `kernelPath` attribute

  - ### withDeviceSlot

    public final WXM1BSDBootDevice 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

  - ### withKernelPath

    public final WXM1BSDBootDevice withKernelPath​(java.nio.file.Path value)
    Copy the current immutable object by setting a value for the `kernelPath` attribute. A shallow reference equality check is used to prevent copying of the same value by returning `this`.
    Parameters:
      `value` - A new value for kernelPath
    Returns:
      A modified copy of the `this` object

  - ### equals

    public boolean equals​(java.lang.Object another)
    This instance is equal to all instances of `WXM1BSDBootDevice` 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: `deviceSlot`, `kernelPath`.
    Overrides:
      `hashCode` in class `java.lang.Object`
    Returns:
      hashCode value

  - ### toString

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

  - ### copyOf

    public static WXM1BSDBootDevice copyOf​(WXM1BSDBootDeviceType instance)
    Creates an immutable copy of a `WXM1BSDBootDeviceType` 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 WXM1BSDBootDevice instance

  - ### builder

    public static WXM1BSDBootDevice.Builder builder()
    Creates a builder for `WXM1BSDBootDevice`.

         WXM1BSDBootDevice.builder()
            .setDeviceSlot(com.io7m.waxmill.machines.WXMDeviceSlot) // required deviceSlot
            .setKernelPath(java.nio.file.Path) // required kernelPath
            .build();

    Returns:
      A new WXM1BSDBootDevice builder