1 /***
2 * Redistribution and use in source and binary forms, with or without
3 * modification, are permitted provided that the following conditions are
4 * met :
5 *
6 * . Redistributions of source code must retain the above copyright
7 * notice, this list of conditions and the following disclaimer.
8 *
9 * . Redistributions in binary form must reproduce the above copyright
10 * notice, this list of conditions and the following disclaimer in the
11 * documentation and/or other materials provided with the distribution.
12 *
13 * . The name of the author may not be used to endorse or promote products
14 * derived from this software without specific prior written permission.
15 *
16 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
17 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
18 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
19 * DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT,
20 * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
21 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
22 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
24 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
25 * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
26 * POSSIBILITY OF SUCH DAMAGE.
27 *
28 * $Id: North.java,v 1.4 2005/09/09 22:36:05 mat007 Exp $
29 */
30
31 package jtge.util.grid.direction;
32
33 import jtge.util.grid.Coordinate;
34 import jtge.util.grid.directiongroup.IDirectionGroup;
35
36 /***
37 * Implements the north direction.
38 *
39 * @author Mathieu Champlon
40 * @version $Revision: 1.4 $ $Date: 2005/09/09 22:36:05 $
41 */
42 public class North extends Direction
43 {
44 /***
45 * Create a north direction.
46 */
47 public North()
48 {
49 super( "North", "N" );
50 }
51
52 /***
53 * {@inheritDoc}
54 */
55 public final Coordinate transform( final Coordinate coordinate, final IDirectionGroup directionGroup )
56 {
57 return directionGroup.transform( coordinate, this );
58 }
59
60 /***
61 * Transforms a coordinate according to the general contract of the direction.
62 *
63 * @param coordinate the coordinate to transform
64 * @return a new coordinate
65 */
66 public final Coordinate transform( final Coordinate coordinate )
67 {
68 if( coordinate == null )
69 return null;
70 final Coordinate result = (Coordinate)coordinate.clone();
71 result.setY( result.getY() - 1 );
72 return result;
73 }
74 }