Circle

java.lang.Object
- cse1030.test1.Circle

All Implemented Interfaces:

Comparable<Circle>
```
public final class Circle
extends Object
implements Comparable<Circle>
```
A class that represents an immutable circle. The circle is defined by its two-dimensional center point and its radius. The class allows circles to be compared using the radius of each circle. The class ensures that all circle objects will always have a radius greater than zero.

Author:

CSE1030_F13_14

Constructor Summary

Constructors
Constructor and Description
`Circle()` Constructs a new circle with center point located at `(0., 0.)` and radius equal to `1`.
`Circle(Circle other)` Constructs a new circle with the same center point and radius as `other`.
`Circle(IPoint2D c, double r)` Constructs a new circle with center point located at `c` and radius equal to `r`.

Method Summary

Methods
Modifier and Type	Method and Description
`int`	`compareTo(Circle other)` Compares two circles by their radius.
`boolean`	`equals(Object obj)` Compares this circle to the specified object.
`IPoint2D`	`getCenter()` Returns the center point of the circle.
`double`	`getRadius()` Returns the radius of the circle.
`String`	`toString()` Returns the string containing the center point of the circle followed by a comma and space, followed by the radius.
`static Circle`	`withDiameter(IPoint2D c, double d)` Returns a new circle with center point located at `c` and diameter equal to `d`.

Methods inherited from class java.lang.Object
clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - Circle
```
public Circle()
```
    Constructs a new circle with center point located at (0., 0.) and radius equal to 1.
  - Circle
```
public Circle(IPoint2D c,
      double r)
```
    Constructs a new circle with center point located at c and radius equal to r.
    
    Throws:
    
    IllegalArgumentException - if the radius is not greater than zero.
    Parameters:
    c - the center point of the circle
    r - the radius of the circle
  - Circle
```
public Circle(Circle other)
```
    Constructs a new circle with the same center point and radius as other.
    
    Parameters:
    other - the circle to copy
- Method Detail
  - getCenter
```
public IPoint2D getCenter()
```
    Returns the center point of the circle.
    
    Returns:
    the center point of the circle
  - getRadius
```
public double getRadius()
```
    Returns the radius of the circle.
    
    Returns:
    the radius of the circle
  - compareTo
```
public int compareTo(Circle other)
```
    Compares two circles by their radius. The result is negative if this circle has a smaller radius than the other circle. The result is positive if this circle has a larger radius than the other circle. The result is 0 if both circles have the same radius.
    
    Specified by:
    
    compareTo in interface Comparable<Circle>
    
    See Also:
    Comparable.compareTo(java.lang.Object)
    Parameters:
    other - the circle to be compared
    
    Returns:
    the value 0 if both circles have the same radius; a negative value if this circle has a smaller radius than the other circle; and a positive value if this circle has a larger radius than the other circle
  - equals
```
public boolean equals(Object obj)
```
    Compares this circle to the specified object. The result is true if and only if the argument is not null and is a Circle object with center point and radius equal to this circle's center point and radius.
    
    Overrides:
    
    equals in class Object
    
    See Also:
    Object.equals(java.lang.Object)
    Parameters:
    obj - the object to compare against this circle
    
    Returns:
    true if the given object represents a Circle equivalent to this circle; false otherwise
  - toString
```
public String toString()
```
    Returns the string containing the center point of the circle followed by a comma and space, followed by the radius. For example:
    System.out.println(new Circle(new IPoint2D(-1.005, 22.1), 3.1415));
    would print the string:
    (-1.005, 22.1), 3.1415
    
    Overrides:
    
    toString in class Object
    
    See Also:
    Object.toString()
    
    Returns:
    a string representation of the circle
  - withDiameter
```
public static Circle withDiameter(IPoint2D c,
                  double d)
```
    Returns a new circle with center point located at c and diameter equal to d.
    
    Throws:
    
    IllegalArgumentException - if the radius of the new circle is not greater than zero.
    Parameters:
    c - the center of the circle
    d - the diameter of the circle
    
    Returns:
    a new circle with center located at c and diameter equal to d

Class Circle

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Circle

Circle

Circle

Method Detail

getCenter

getRadius

compareTo

equals

toString

withDiameter