Class Disk

java.lang.Object

Disk

All Implemented Interfaces:

java.lang.Comparable<Disk>

public class Disk
extends java.lang.Object
implements java.lang.Comparable<Disk>

A Disk represents a disk and has one field, radius. Disk has one Constructor, which takes a given radius and creates a Disk with that radius. It also has a compareTo() method, which compares Disks based on their radii. It also has a toString(), which returns the String representation of a Disk, which for this class is the Disk's radius.

Author:

AnneMarie Caballero (annemariecabs)

Field Summary

Fields

Modifier and Type	Field	Description
private int	radius	an integer that holds the radius of the disk

Constructor Summary

Constructors

Constructor	Description
Disk(int r)	Constructs a disk using a given radius.

Method Summary

Modifier and Type	Method	Description
int	compareTo(Disk o)	Compares this disk with another disk and returns an integer representing that comparison.
java.lang.String	toString()	Returns a String representation of the disk, namely its radius.

Methods inherited from class java.lang.Object

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

Field Detail

radius

private int radius

an integer that holds the radius of the disk

Constructor Detail

Disk

public Disk(int r)
     throws java.lang.IllegalArgumentException

Constructs a disk using a given radius.

Parameters:

r - the radius of the disk to be created

Throws:

java.lang.IllegalArgumentException - if r is not valid because it is less than or equal to zero

Method Detail

compareTo

public int compareTo(Disk o)

Compares this disk with another disk and returns an integer representing that comparison.

Specified by:

compareTo in interface java.lang.Comparable<Disk>

Parameters:

o - the other Disk that this disk is being compared to

Returns:

a negative integer if this is less than o, a positive integer if this is greater than o, and 0 if they are equal

See Also:

Comparable.compareTo(java.lang.Object)

toString

public java.lang.String toString()

Returns a String representation of the disk, namely its radius.

Overrides:

toString in class java.lang.Object

Returns:

the radius of the Disk as a String (the Disk's String representation)

See Also:

Object.toString()