Class Square

java.lang.Object

Square

public class Square
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
private LineSegment	ls1 A square is defined by two line segments that have a common end-point.
private LineSegment	ls2 A square is defined by two line segments that have a common end-point.

Constructor Summary

Constructors

Constructor and Description
Square(LineSegment ls1, LineSegment ls2) A constructor for the Square object.

Method Summary

Modifier and Type	Method and Description
double	area() Method to compute the area of 'this' Square
boolean	equals(java.lang.Object obj) Method to compare 'this' Square segment for equality with the 'object' specified as a parameter.
LineSegment	getLs1() Getter for LineSegment 1
LineSegment	getLs2() Getter for LineSegment 2
double	perimeter() Method to compute the perimeter of 'this' Square
java.lang.String	toString() Method to render 'this' instance of the Square class into a String.

Methods inherited from class java.lang.Object

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

Field Detail

ls1

private LineSegment ls1

A square is defined by two line segments that have a common end-point. The two line segments must be perpendicular and of equal length.

ls2

private LineSegment ls2

A square is defined by two line segments that have a common end-point. The two line segments must be perpendicular and of equal length.

Constructor Detail

Square

public Square(LineSegment ls1,
              LineSegment ls2)
       throws LineSegmentsNotPerpendicularException,
              LineSegmentsNotAdjacentException,
              LineSegmentsUnequalException

A constructor for the Square object. This constructor accepts two LineSegments as arguments. The two LineSegments must share a common end-point, must be perpendicular to each other and must be of equal length. A violation of any of these requirements leads to the constructor throwing an exception

Parameters:

ls1 - The first LineSegment defining the square

ls2 - The second LineSegment defining the square

Throws:

LineSegmentsNotPerpendicularException - This exception is thrown if the two LineSegments are not perpendicular to each other

LineSegmentsNotAdjacentException - This exception is thrown if the LineSegments do not share a common end-point.

LineSegmentsUnequalException - This exception is thrown if the LineSegments are not of equal length.

Method Detail

area

public double area()

Method to compute the area of 'this' Square

Returns:

The area of 'this' Square

perimeter

public double perimeter()

Method to compute the perimeter of 'this' Square

Returns:

The perimeter of 'this' Square

getLs1

public LineSegment getLs1()

Getter for LineSegment 1

Returns:

The LineSegment representing LineSegment 1

getLs2

public LineSegment getLs2()

Getter for LineSegment 2

Returns:

The LineSegment representing LineSegment 2

equals

public boolean equals(java.lang.Object obj)

Method to compare 'this' Square segment for equality with the 'object' specified as a parameter.

Overrides:

equals in class java.lang.Object

Parameters:

obj - An Object to be tested for equality with 'this' Square

Returns:

Returns true if the specified 'object' is a Square with equal LineSegments defining both Squares.

toString

public java.lang.String toString()

Method to render 'this' instance of the Square class into a String.

Overrides:

toString in class java.lang.Object

Returns:

Returns the String "Square = " + this.ls1 + " and " + this.ls2