myhw3.data

Class InventorySet

java.lang.Object

myhw3.data.InventorySet

All Implemented Interfaces:

java.lang.Iterable<Record>, Inventory

final class InventorySet
extends java.lang.Object
implements Inventory

Implementation of Inventory interface.

See Also:

Data

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private static class	InventorySet.RecordObj Implementation of Record interface.

Field Summary

Fields

Modifier and Type	Field and Description
private java.util.Map<Video,Record>	data
private CommandHistory	history

Constructor Summary

Constructors

Constructor and Description
InventorySet()

Method Summary

Modifier and Type	Method and Description
(package private) Record	addNumOwned(Video video, int change) Add or remove copies of a video from the inventory.
(package private) Record	checkIn(Video video) Check in a video.
(package private) Record	checkOut(Video video) Check out a video.
(package private) java.util.Map<Video,Record>	clear() Remove all records from the inventory.
Record	get(Video v) Return the record for a given Video; if not present, return null.
(package private) CommandHistory	getHistory() Return a reference to the history.
java.util.Iterator<Record>	iterator() Return an iterator over Records in the Inventory.
java.util.Iterator<Record>	iterator(java.util.Comparator<Record> comparator) Return an iterator over the Inventory, sorted accoring the Comparator.
boolean	redo() Undo the last successful UndoableCommand.
(package private) void	replaceEntry(Video video, Record record) If record is null, then delete record for video; otherwise replace record for video.
(package private) void	replaceMap(java.util.Map<Video,Record> data) Overwrite the map.
int	size() Return the number of Records.
java.lang.String	toString() Returns the inventory as a string; one record per line.
boolean	undo() Undo the last successful UndoableCommand.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Detail

data

private java.util.Map<Video,Record> data

history

private final CommandHistory history

Constructor Detail

InventorySet

InventorySet()

Method Detail

replaceEntry

void replaceEntry(Video video,
                  Record record)

If record is null, then delete record for video; otherwise replace record for video.

replaceMap

void replaceMap(java.util.Map<Video,Record> data)

Overwrite the map.

size

public int size()

Description copied from interface: Inventory

Return the number of Records.

Specified by:

size in interface Inventory

get

public Record get(Video v)

Description copied from interface: Inventory

Return the record for a given Video; if not present, return null.

Specified by:

get in interface Inventory

iterator

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

Description copied from interface: Inventory

Return an iterator over Records in the Inventory.

The iterator returns objects that implement the Record interface.

Any attempt to remove objects using the iterator should result in an UnsupportedOperationException.

The Record order is unspecified

Specified by:

iterator in interface java.lang.Iterable<Record>

Specified by:

iterator in interface Inventory

undo

public boolean undo()

Description copied from interface: Inventory

Undo the last successful UndoableCommand.

Specified by:

undo in interface Inventory

redo

public boolean redo()

Description copied from interface: Inventory

Undo the last successful UndoableCommand.

Specified by:

redo in interface Inventory

iterator

public java.util.Iterator<Record> iterator(java.util.Comparator<Record> comparator)

Description copied from interface: Inventory

Return an iterator over the Inventory, sorted accoring the Comparator.

The iterator returns objects that implement the Record interface.

Any attempt to remove objects using the iterator should result in an UnsupportedOperationException.

The iteration order is determined by the comparator (least first).

The comparator may assume that its arguments implement Record.

Specified by:

iterator in interface Inventory

Parameters:

comparator - determines the order of the records returned.

addNumOwned

Record addNumOwned(Video video,
                   int change)

Add or remove copies of a video from the inventory. If a video record is not already present (and change is positive), a record is created. If a record is already present, numOwned is modified using change. If change brings the number of copies to be zero, the record is removed from the inventory.

Parameters:

video - the video to be added.

change - the number of copies to add (or remove if negative).

Returns:

A copy of the previous record for this video (if any)

Throws:

java.lang.IllegalArgumentException - if video null, change is zero, if attempting to remove more copies than are owned, or if attempting to remove copies that are checked out.

checkOut

Record checkOut(Video video)

Check out a video.

Parameters:

video - the video to be checked out.

Returns:

A copy of the previous record for this video

Throws:

java.lang.IllegalArgumentException - if video has no record or numOut equals numOwned.

checkIn

Record checkIn(Video video)

Check in a video.

Parameters:

video - the video to be checked in.

Returns:

A copy of the previous record for this video

Throws:

java.lang.IllegalArgumentException - if video has no record or numOut non-positive.

clear

java.util.Map<Video,Record> clear()

Remove all records from the inventory.

Returns:

A copy of the previous inventory as a Map

getHistory

CommandHistory getHistory()

Return a reference to the history.

toString

public java.lang.String toString()

Description copied from interface: Inventory

Returns the inventory as a string; one record per line.

Specified by:

toString in interface Inventory

Overrides:

toString in class java.lang.Object