package cse1030.test2;

import cse1030.drawing.Point2D;

/**
 * A class for finding two dimensional points that match a point stored by a
 * <code>PointMatcher</code> object.
 * 
 * @author CSE1030_F13_14
 * 
 */
public class PointMatcher {

  /**
   * The point stored by the <code>PointMatcher</code>
   */
  protected Point2D point;

  /**
   * Creates a <code>PointMatcher</code> object using the given point
   * <code>p</code>. The point <code>p</code> is used by the matcher to define
   * the matching criteria. This class matches points that are equal to
   * <code>p</code>, but subclasses are expected to define different matching
   * criteria.
   * 
   * @param p
   *          the point to match
   */
  public PointMatcher(Point2D p) {
    this.point = new Point2D(p);
  }

  /**
   * Get the point that this <code>PointMatcher</code> object uses to define the
   * matching criteria. Clients cannot use this method to modify the point;
   * clients must use <code>setPoint</code> to modify the point that this
   * <code>PointMatcher</code> object matches.
   * 
   * @return the point that this <code>PointMatcher</code> uses to define the
   *         matching criteria.
   */
  public Point2D getPoint() {
    return new Point2D(this.point);
  }

  /**
   * Set the point that this <code>PointMatcher</code> object uses to define the
   * matching criteria.
   * 
   * @param p
   *          the point that this <code>PointMatcher</code> should use to define
   *          the matching criteria.
   */
  public void setPoint(Point2D p) {
    this.point = new Point2D(p);
  }

  /**
   * Checks whether or not the point <code>other</code> matches the point held
   * by this <code>PointMatcher</code>. This <code>PointMatcher</code> uses
   * <code>equals</code> to determine if its point matches <code>other</code>,
   * but subclasses of <code>PointMatcher</code> are expected to change this
   * behavior.
   * 
   * @param other
   *          the point to check for a match
   * @return <code>true</code> if this <code>PointMatcher</code>'s point is
   *         equal to <code>other</code>
   */
  public boolean matches(Point2D other) {
    return this.point.equals(other);
  }

}