org.eclipse.swt.graphics.Point Maven / Gradle / Ivy
/*******************************************************************************
* Copyright (c) 2002, 2011 Innoopract Informationssysteme GmbH and others.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0
* which accompanies this distribution, and is available at
* http://www.eclipse.org/legal/epl-v10.html
*
* Contributors:
* Innoopract Informationssysteme GmbH - initial API and implementation
* EclipseSource - ongoing development
******************************************************************************/
package org.eclipse.swt.graphics;
import org.eclipse.swt.internal.SerializableCompatibility;
/**
* Instances of this class represent places on the (x, y)
* coordinate plane.
*
* The coordinate space for rectangles and points is considered
* to have increasing values downward and to the right from its
* origin making this the normal, computer graphics oriented notion
* of (x, y) coordinates rather than the strict mathematical one.
*
*
* The hashCode() method in this class uses the values of the public
* fields to compute the hash value. When storing instances of the
* class in hashed collections, do not modify these fields after the
* object has been inserted.
*
*
* Application code does not need to explicitly release the
* resources managed by each instance when those instances are no longer
* required, and thus no dispose() method is provided.
*
*
* @see Rectangle
*
* @since 1.0
*/
public final class Point implements SerializableCompatibility {
/**
* the x coordinate of the point
*/
public int x;
/**
* the y coordinate of the point
*/
public int y;
/**
* Constructs a new point with the given x and y coordinates.
*
* @param x the x coordinate of the new point
* @param y the y coordinate of the new point
*/
public Point( int x, int y ) {
this.x = x;
this.y = y;
}
/**
* Compares the argument to the receiver, and returns true
* if they represent the same object using a class
* specific comparison.
*
* @param object the object to compare with this object
* @return true if the object is the same as this object and false otherwise
*
* @see #hashCode()
*/
public boolean equals( Object object ) {
boolean result = object == this;
if( !result && object instanceof Point ) {
Point toCompare = ( Point )object;
result = toCompare.x == this.x
&& toCompare.y == this.y;
}
return result;
}
/**
* Returns an integer hash code for the receiver. Any two
* objects that return true when passed to
* equals must return the same value for this
* method.
*
* @return the receiver's hash
*
* @see #equals(Object)
*/
public int hashCode() {
return x ^ y;
}
/**
* Returns a string containing a concise, human-readable
* description of the receiver.
*
* @return a string representation of the point
*/
public String toString () {
return "Point {" + x + ", " + y + "}";
}
}