hw1

Class Box

java.lang.Object

hw1.Box

All Implemented Interfaces:

java.lang.Iterable<Ball>

public class Box
extends java.lang.Object
implements java.lang.Iterable<Ball>

This is a container can be used to contain Balls. The key difference between a BallContainer and a Box is that a Box has a finite volume. Once a box is full, a client cannot put in more Balls.

Constructor Summary

Constructors

Constructor and Description
Box(double maxVolume) Constructor that creates a new box.

Method Summary

Modifier and Type	Method and Description
boolean	add(Ball b) Adds a Ball to this box.
void	clear() Empties the box, i.e.
boolean	contains(Ball b) This method returns true if this box contains the specified Ball.
java.util.Iterator<Ball>	getBallsFromSmallest() This method returns an iterator that yields all the balls in this box in order of ascending size, i.e., the smallest Ball first, followed by Balls of increasing size.
double	getVolume() Each Ball has a volume.
java.util.Iterator<Ball>	iterator() Implements the Iterable interface for this box.
boolean	remove(Ball b) Removes a ball from the box.
int	size() Returns the number of Balls in this box.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

Box

public Box(double maxVolume)

Constructor that creates a new box.

Parameters:

maxVolume - total volume of balls that this box can contain

Method Detail

iterator

public java.util.Iterator<Ball> iterator()

Implements the Iterable interface for this box.

Specified by:

iterator in interface java.lang.Iterable<Ball>

Returns:

an Iterator over the Ball objects contained in this box

add

public boolean add(Ball b)

Adds a Ball to this box.

Parameters:

b - the Ball to be added

Returns:

true if ball was successfully added to the box, i.e. ball was not already in the box and the box was not already full. Returns false, if ball was already in the box or if the box was too full to contain the new ball.

Requires:

b != null

getBallsFromSmallest

public java.util.Iterator<Ball> getBallsFromSmallest()

This method returns an iterator that yields all the balls in this box in order of ascending size, i.e., the smallest Ball first, followed by Balls of increasing size.

Returns:

an iterator that yields all the balls in this box in order of ascending size

remove

public boolean remove(Ball b)

Removes a ball from the box. This method returns true if ball was successfully removed from the container, i.e. ball was actually in the box. This method returns false otherwise.

Parameters:

b - the Ball to be removed

Returns:

true if the ball was successfully removed from the box, i.e. ball was actually in the box. Returns false if the ball was not in the box.

Requires:

b != null

getVolume

public double getVolume()

Each Ball has a volume. This method returns the total volume of all the Balls in the box.

Returns:

the volume of the contents of the box

size

public int size()

Returns the number of Balls in this box.

Returns:

the number of Balls in this box

clear

public void clear()

Empties the box, i.e. removes all its contents.

contains

public boolean contains(Ball b)

This method returns true if this box contains the specified Ball. It returns false otherwise.

Parameters:

b - the Ball to be checked for membership in this box

Returns:

true if this box contains the specified Ball. Returns false otherwise.

Requires:

b != null