org.opentcs.drivers.vehicle.LoadHandlingDevice Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of opentcs-api-base Show documentation

opentcs-api-base

There is a newer version: 6.2.0

/**
 * Copyright (c) The openTCS Authors.
 *
 * This program is free software and subject to the MIT license. (For details,
 * see the licensing information (LICENSE.txt) you should have received with
 * this copy of the software.)
 */
package org.opentcs.drivers.vehicle;

import static java.util.Objects.requireNonNull;

import java.io.Serializable;
import java.util.Objects;

/**
 * Describes a single load handling device on a vehicle.
 */
public class LoadHandlingDevice
    implements
      Serializable {

  /**
   * A name/label for this device.
   */
  private final String label;
  /**
   * A flag indicating whether this device is filled to its maximum capacity or
   * not.
   */
  private final boolean full;

  /**
   * Creates a new LoadHandlingDevice.
   *
   * @param label The device's name/label.
   * @param full A flag indicating whether this device is filled to its maximum
   * capacity or not.
   */
  public LoadHandlingDevice(String label, boolean full) {
    this.label = requireNonNull(label, "label");
    this.full = full;
  }

  /**
   * Returns this load handling device's name/label.
   *
   * @return This load handling device's name/label.
   */
  public String getLabel() {
    return label;
  }

  /**
   * Returns a flag indicating whether this device is filled to its maximum
   * capacity or not.
   *
   * @return A flag indicating whether this device is filled to its maximum
   * capacity or not.
   */
  public boolean isFull() {
    return full;
  }

  @Override
  public String toString() {
    return "LoadHandlingDevice{" + "label=" + label + ", full=" + full + '}';
  }

  @Override
  public boolean equals(Object obj) {
    if (obj == null) {
      return false;
    }
    if (!(obj instanceof LoadHandlingDevice)) {
      return false;
    }
    final LoadHandlingDevice other = (LoadHandlingDevice) obj;
    if (!Objects.equals(this.label, other.label)) {
      return false;
    }
    if (this.full != other.full) {
      return false;
    }
    return true;
  }

  @Override
  public int hashCode() {
    int hash = 7;
    hash = 23 * hash + Objects.hashCode(this.label);
    hash = 23 * hash + (this.full ? 1 : 0);
    return hash;
  }
}