org.josef.science.math.geometry

Class CLine

java.lang.Object

org.josef.science.math.geometry.CLine

All Implemented Interfaces:

Serializable

@Status(stage=DEVELOPMENT,
        unitTests=COMPLETE)
 @ThreadSafety(level=IMMUTABLE)
public class CLine
extends Object
implements Serializable

Abstraction of a line.
A line consists of two CPoints.

Version:

1.0 $Revision: 5460 $

Author:

Kees Schotanus

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
CLine(CPoint fromPoint, CPoint toPoint) Creates this CLine from the supplied CPoints.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object line) Determines whether this CLine is equal to the supplied line.
CPoint	getFromPoint() Gets the first CPoint of this CLine.
double	getLength() Gets the length of this CLine.
CPoint	getToPoint() Gets the second CPoint of this CLine.
int	hashCode() Computes the hash code of this CLine.
String	toString() Creates a String representation of this CLine.

Methods inherited from class java.lang.Object

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

Constructor Detail

CLine

public CLine(CPoint fromPoint,
             CPoint toPoint)

Creates this CLine from the supplied CPoints.

Parameters:

fromPoint - From point.

toPoint - To point.

Throws:

NullPointerException - When either the supplied fromPoint or toPoint is null.

ArithmeticException - When the supplied points are equal.

Method Detail

getFromPoint

public CPoint getFromPoint()

Gets the first CPoint of this CLine.

Returns:

The first CPoint of this CLine.

getToPoint

public CPoint getToPoint()

Gets the second CPoint of this CLine.

Returns:

The second CPoint of this CLine.

getLength

public double getLength()

Gets the length of this CLine.
The length of a line is computed by: √((x1 - x2)² + (y1 - y2)²)

Returns:

The length of this CLine.

equals

public boolean equals(Object line)

Determines whether this CLine is equal to the supplied line.

Overrides:

equals in class Object

Parameters:

line - The line to compare to this CLine.

Returns:

True when the supplied line is non-null, is of type CLine and both the from point and to point of both lines are the same.
Otherwise false is returned.

hashCode

public int hashCode()

Computes the hash code of this CLine.

Overrides:

hashCode in class Object

Returns:

The hash code of this CLine.

toString

public String toString()

Creates a String representation of this CLine.
The format of the returned String is CLine:(x1,y1)-(x2,y2).

Overrides:

toString in class Object

Returns:

A String representation of this CLine.