root/tools/routingservice/trunk/src/jp/co/orkney/restlet/util/Point.java

package jp.co.orkney.restlet.util;

/**
 * Copyright (c) 2008 Orkney, Inc. <http://www.orkney.co.jp/>
 * 
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 * 
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 * 
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
 
import java.math.BigDecimal;


/**
 * <b>Point is a class which represents a point.</b>
 * <p>
 * Point object is characterized by the following information:
 * <ul>
 * <li>Two coordinates: X and Y</li>
 * </ul>
 * </p>
 * 
 * @author Matthieu Bilbille - Orkney Inc.
 * @version 1.0
 */
public class Point
{
        private BigDecimal x;
        private BigDecimal y;
        
        /**
         * Constructor Point.
         * <p>
         * Creates a new point with X and Y initialized at 0
         * </p>
         */
        public Point()
        {
                x = new BigDecimal(0);
                y = new BigDecimal(0);
        }
        /**
         * Constructor Point.
         * <p>
         * Creates a new point with the specified X and Y values.
         * </p>
         * @param x X value
         * @param y Y value
         */
        public Point(BigDecimal x, BigDecimal y)
        {
                this.x = x;
                this.y = y;
        }
        
        /**
         * Gets the X value of the point
         * 
         * @return this point's X value
         */
        public BigDecimal getX()
        {
                return x;
        }
        
        /**
         * Makes an addition between X value and the specified integer, and gets the result
         * @param value value to add
         * @return result of this addition
         */
        public BigDecimal getX(float value)
        {
                return x.add(new BigDecimal(value));
        }
        
        /**
         * Gets the Y value of the point
         * 
         * @return this point's Y value
         */
        public BigDecimal getY()
        {
                return y;
        }
        
        /**
         * Makes an addition between Y value and the specified integer, and gets the result
         * @param value value to add
         * @return result of this addition
         */
        public BigDecimal getY(float value)
        {
                return y.add(new BigDecimal(value));
        }
        
        /**
         * Sets the X value of the point to the specified bigdecimal.
         * 
         * @param x
         *            the bigdecimal that is to be this point's X value
         */
        public void setX(BigDecimal x)
        {
                this.x = x;
        }
        
        /**
         * Sets the Y value of the point to the specified bigdecimal.
         * 
         * @param y
         *            the bigdecimal that is to be this point's Y value
         */
        public void setY(BigDecimal y)
        {
                this.y = y;
        }
        
}