org.opentcs.access.to.model.CoupleCreationTO 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.4.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.to.model;

import java.io.Serializable;

/**
 * A transfer object describing generic 2-tuple of long integer values.
 */
public class CoupleCreationTO
    implements
      Serializable {

  private final long x;
  private final long y;

  /**
   * Creates a new instance.
   *
   * @param x The X coordinate.
   * @param y The Y coordinate.
   */
  public CoupleCreationTO(long x, long y) {
    this.x = x;
    this.y = y;
  }

  /**
   * Returns the x coordinate.
   *
   * @return The x coordinate.
   */
  public long getX() {
    return x;
  }

  /**
   * Creates a copy of this object, with the given x coordinate.
   *
   * @param x The value to be set in the copy.
   * @return A copy of this object, differing in the given value.
   */
  public CoupleCreationTO withX(long x) {
    return new CoupleCreationTO(x, y);
  }

  /**
   * Returns the y coordinate.
   *
   * @return The y coordinate.
   */
  public long getY() {
    return y;
  }

  /**
   * Creates a copy of this object, with the given y coordinate.
   *
   * @param y The value to be set in the copy.
   * @return A copy of this object, differing in the given value.
   */
  public CoupleCreationTO withY(long y) {
    return new CoupleCreationTO(x, y);
  }
}