org.opentcs.access.rmi.ClientID 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.access.rmi;

import java.io.Serializable;
import static java.util.Objects.requireNonNull;
import java.util.UUID;
import javax.annotation.Nonnull;

/**
 * Identifies a remote client unambiguously.
 *
 * @author Stefan Walter (Fraunhofer IML)
 */
public class ClientID
implements Serializable {
  /**
   * The client's name.
   */
  private final String clientName;
  /**
   * The client's UUID.
   */
  private final UUID uuid;
  
  /**
   * Creates a new ClientID.
   *
   * @param clientName The client's name.
   */
  public ClientID(@Nonnull String clientName) {
    this.clientName = requireNonNull(clientName, "clientName");
    uuid = UUID.randomUUID();
  }
  
  /**
   * Return the client's name.
   *
   * @return The client's name.
   */
  @Nonnull
  public String getClientName() {
    return clientName;
  }
  
  /**
   * Checks if this object equals another one.
   *
   * @param otherObject The other object to be compared with this object.
   * @return true if, and only if, the given object is also a
   * ClientID and contains the same name and the same UUID as this
   * one.
   */
  @Override
  public boolean equals(Object otherObject) {
    if (otherObject instanceof ClientID) {
      ClientID otherID = (ClientID) otherObject;
      return clientName.equals(otherID.clientName) && uuid.equals(otherID.uuid);
    }
    else {
      return false;
    }
  }
  
  @Override
  public int hashCode() {
    return uuid.hashCode();
  }
  
  @Override
  public String toString() {
    return clientName + ":" + uuid;
  }
}