ball.util

Class Coordinate

java.lang.Object

ball.util.Coordinate

All Implemented Interfaces:

Serializable, Comparable<Coordinate>

public class Coordinate
extends Object
implements Comparable<Coordinate>, Serializable

X-Y coordinate representation.

Bean Property Summary

Name	Mode	Type	isHidden	isBound	isConstrained
x	R	int	false	false	false
y	R	int	false	false	false

Version:

$Revision: 5285 $

Author:

Allen D. Ball

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Coordinate(Number y, Number x)

Method Summary

Modifier and Type	Method and Description
Point2D	asPoint() Method to translate this Coordinate to a Point2D.
int	compareTo(Coordinate that)
boolean	equals(Object object)
int	getX()
int	getY()
int	hashCode()
static SortedSet<Coordinate>	range(Coordinate min, Coordinate max) Static method to return a SortedSet of Coordinates specified by the parameters.
static SortedSet<Coordinate>	range(int y0, int x0, int yN, int xN) Static method to return a SortedSet of Coordinates specified by the parameters.
String	toString()
Coordinate	translate(Coordinate ds) Method to getthe Coordinate relative to this Coordinate.
Coordinate	translate(Number dy, Number dx) Method to get the Coordinate relative to this Coordinate.
boolean	within(Coordinate min, Coordinate max) Method to determine if this Coordinate is within the area described by the argument Coordinates.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Coordinate

@ConstructorProperties(value={"y","x"})
public Coordinate(Number y,
                                                          Number x)

Parameters:

y - The Y-coordinate.

x - The X-coordinate.

Method Detail

getY

public int getY()

getX

public int getX()

translate

public Coordinate translate(Number dy,
                            Number dx)

Method to get the Coordinate relative to this Coordinate.

Parameters:

dy - The change in Y-coordinate.

dx - The change in X-coordinate.

Returns:

The relative Coordinate.

translate

public Coordinate translate(Coordinate ds)

Method to getthe Coordinate relative to this Coordinate.

Parameters:

ds - The Coordinate describing the change.

Returns:

The relative Coordinate.

within

public boolean within(Coordinate min,
                      Coordinate max)

Method to determine if this Coordinate is within the area described by the argument Coordinates.

Parameters:

min - The minimum Coordinate.

max - The maximum Coordinate.

Returns:

true if within the area; false otherwise.

asPoint

public Point2D asPoint()

Method to translate this Coordinate to a Point2D.

Returns:

The Point.

compareTo

public int compareTo(Coordinate that)

Specified by:

compareTo in interface Comparable<Coordinate>

equals

public boolean equals(Object object)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

range

public static SortedSet<Coordinate> range(Coordinate min,
                                          Coordinate max)

Static method to return a SortedSet of Coordinates specified by the parameters.

Parameters:

min - [y0, x0]

max - [yN, xN]

Returns:

The SortedSet of Coordinates.

range

public static SortedSet<Coordinate> range(int y0,
                                          int x0,
                                          int yN,
                                          int xN)

Static method to return a SortedSet of Coordinates specified by the parameters.

Parameters:

y0 - MIN(y)

x0 - MIN(x)

yN - MAX(y) + 1

xN - MAX(x) + 1

Returns:

The SortedSet of Coordinates.