uk.org.retep.util.math.Point Maven / Gradle / Ivy
/*
* Copyright (c) 1998-2010, Peter T Mount
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
*
* - Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
*
* - Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* - Neither the name of the retep.org.uk nor the names of its contributors
* may be used to endorse or promote products derived from this software
* without specific prior written permission.
*
*
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER
* OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
* EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
* PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
* PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
* LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
* NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package uk.org.retep.util.math;
/**
* A two dimensional point in space
*
* @param Type of number
* @author peter
* @since 9.12
*/
public abstract class Point
{
protected T x;
protected T y;
/**
* Construct a Point with the specified coordinates
*
* @param x X coordinate
* @param y Y coordinate
*/
public Point( final T x, final T y )
{
this.x = x;
this.y = y;
}
/**
* The X coordinate
*
* @return X coordinate
*/
public final T getX()
{
return x;
}
/**
* Set the X coordinate
*
* @param x X coordinate
*/
public final void setX( final T x )
{
this.x = x;
}
/**
* The Y coordinate
*
* @return Y coordinate
*/
public final T getY()
{
return y;
}
/**
* Set the Y coordinate
*
* @param y Y coordinate
*/
public final void setY( final T y )
{
this.y = y;
}
@Override
public final String toString()
{
final StringBuilder sb = new StringBuilder( getClass().getName() );
sb.append( '[' ).append( x ).append( ',' ).append( y );
return appendOpt( sb ).append( ']' ).toString();
}
/**
* Allows subclasses to add to the {@link #toString() } method
*
* @param sb StringBuilder forming the string
* @return sb
*/
protected StringBuilder appendOpt( final StringBuilder sb )
{
return sb;
}
/**
* A {@link Point} using {@link java.lang.Double}'s for the coordinates
*
*/
public static class Double
extends Point
{
/**
* A point with coordinates (0,0)
*/
public Double()
{
super( 0.0, 0.0 );
}
/**
* A point with the supplied coordinates
*
* @param x X coordinate
* @param y Y coordinate
*/
public Double( final java.lang.Double x, final java.lang.Double y )
{
super( x, y );
}
}
/**
* A {@link Point} using {@link java.lang.Float}'s for the coordinates
*
*/
public static class Float
extends Point
{
/**
* A point with coordinates (0,0)
*/
public Float()
{
super( 0F, 0F );
}
/**
* A point with the supplied coordinates
*
* @param x X coordinate
* @param y Y coordinate
*/
public Float( final java.lang.Float x, final java.lang.Float y )
{
super( x, y );
}
}
/**
* A {@link Point} using {@link java.math.BigDecimal}'s for the coordinates
*
*/
public static class BigDecimal
extends Point
{
/**
* A point with coordinates (0,0)
*/
public BigDecimal()
{
super( java.math.BigDecimal.ZERO, java.math.BigDecimal.ZERO );
}
/**
* A point with the supplied coordinates
*
* @param x X coordinate
* @param y Y coordinate
*/
public BigDecimal( final java.math.BigDecimal x,
final java.math.BigDecimal y )
{
super( x, y );
}
}
}