Coordinate

java.lang.Object
- shared.model.map.Coordinate

All Implemented Interfaces:

java.io.Serializable
```
public class Coordinate
extends java.lang.Object
implements java.io.Serializable
```
Stores a X, Y coordinate pair.

Author:

Jonathan Sadler

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type Field and Description

private static long serialVersionUID

private int x

private int y

Fields
Modifier and Type	Field and Description
`private static long`	`serialVersionUID`
`private int`	`x`
`private int`	`y`

Constructor Summary

Constructors
Constructor and Description

Coordinate(int x, int y)
Creates a coordinate object.

Constructors
Constructor and Description
`Coordinate(int x, int y)` Creates a coordinate object.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(java.lang.Object obj)`
`Coordinate`	`GetEast()` Returns the coordinate to the right of the current coordinate.
`Coordinate`	`GetNorth()` Gets the coordinate above the current coordinate.
`Coordinate`	`GetNorthEast()` Returns the coordinate above and to the right of the current coordinate.
`Coordinate`	`GetNorthWest()` Returns the coordinate above and to the left of the current coordinate.
`Coordinate`	`GetSouth()` Returns the coordinate below the current coordinate.
`Coordinate`	`GetSouthEast()` Returns the coordinate below and to the right of the current coordinate.
`Coordinate`	`GetSouthWest()` Returns the coordinate below and to the left of the current coordinate.
`Coordinate`	`GetWest()` Returns the coordinate to the left of the current coordinate.
`int`	`getX()`
`int`	`getY()`
`int`	`hashCode()`
`boolean`	`isLeftHandCoordinate()` Determines if the coordinate is left handed.
`boolean`	`isRightHandCoordinate()` Determines if the coordinate is right handed.
`java.lang.String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - serialVersionUID
```
private static final long serialVersionUID
```
    See Also:
    
    Constant Field Values
  - x
```
private int x
```
  - y
```
private int y
```
- Constructor Detail
  - Coordinate
```
public Coordinate(int x,
                  int y)
```
    Creates a coordinate object.
    
    Parameters:
    
    x - X Coordinate
    
    y - Y Coordinate
- Method Detail
  - GetNorth
```
public Coordinate GetNorth()
```
    Gets the coordinate above the current coordinate.
    
    Returns:
    
    The coordinate.
  - GetNorthEast
```
public Coordinate GetNorthEast()
```
    Returns the coordinate above and to the right of the current coordinate.
    
    Returns:
    
    The coordinate.
  - GetEast
```
public Coordinate GetEast()
```
    Returns the coordinate to the right of the current coordinate.
    
    Returns:
    
    The coordinate.
  - GetSouthEast
```
public Coordinate GetSouthEast()
```
    Returns the coordinate below and to the right of the current coordinate.
    
    Returns:
    
    The coordinate.
  - GetSouth
```
public Coordinate GetSouth()
```
    Returns the coordinate below the current coordinate.
    
    Returns:
    
    The coordinate.
  - GetSouthWest
```
public Coordinate GetSouthWest()
```
    Returns the coordinate below and to the left of the current coordinate.
    
    Returns:
    
    The coordinate.
  - GetWest
```
public Coordinate GetWest()
```
    Returns the coordinate to the left of the current coordinate.
    
    Returns:
    
    The coordinate.
  - GetNorthWest
```
public Coordinate GetNorthWest()
```
    Returns the coordinate above and to the left of the current coordinate.
    
    Returns:
    
    The coordinate.
  - getX
```
public int getX()
```
    Returns:
    
    the x
  - getY
```
public int getY()
```
    Returns:
    
    the y
  - isLeftHandCoordinate
```
public boolean isLeftHandCoordinate()
```
    Determines if the coordinate is left handed.
    
    Returns:
    
    True if yes, else false.
  - isRightHandCoordinate
```
public boolean isRightHandCoordinate()
```
    Determines if the coordinate is right handed.
    
    Returns:
    
    True is yes, else false.
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Overrides:
    
    equals in class java.lang.Object
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object

Class Coordinate

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

serialVersionUID

x

y

Constructor Detail

Coordinate

Method Detail

GetNorth

GetNorthEast

GetEast

GetSouthEast

GetSouth

GetSouthWest

GetWest

GetNorthWest

getX

getY

isLeftHandCoordinate

isRightHandCoordinate

hashCode

equals

toString