bag

Class Bag<T>

java.lang.Object

bag.Bag<T>

All Implemented Interfaces:

BagInterface<T>

public final class Bag<T>
extends java.lang.Object
implements BagInterface<T>

A class of bags whose entries are stored in a chain of linked nodes. The bag is never full.

Version:

4.1

Author:

Frank M. Carrano, Timothy M. Henry, maellis1 changed from LinkedBag

Constructor Summary

Constructors

Constructor and Description
Bag()

Method Summary

Modifier and Type	Method and Description
boolean	add(T newEntry) Adds a new entry to this bag.
void	clear() Removes all entries from this bag.
boolean	contains(T anEntry) Tests whether this bag contains a given entry.
int	getCurrentSize() Gets the number of entries currently in this bag.
int	getFrequencyOf(T anEntry) Counts the number of times a given entry appears in this bag.
boolean	isEmpty() Sees whether this bag is empty.
T	remove() Removes one unspecified entry from this bag, if possible.
boolean	remove(T anEntry) Removes one occurrence of a given entry from this bag, if possible.
T[]	toArray() Retrieves all entries that are in this bag.

Methods inherited from class java.lang.Object

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

Constructor Detail

Bag

public Bag()

Method Detail

isEmpty

public boolean isEmpty()

Sees whether this bag is empty.

Specified by:

isEmpty in interface BagInterface<T>

Returns:

True if this bag is empty, or false if not.

getCurrentSize

public int getCurrentSize()

Gets the number of entries currently in this bag.

Specified by:

getCurrentSize in interface BagInterface<T>

Returns:

The integer number of entries currently in this bag.

add

public boolean add(T newEntry)

Adds a new entry to this bag.

Specified by:

add in interface BagInterface<T>

Parameters:

newEntry - The object to be added as a new entry

Returns:

True if the addition is successful, or false if not.

toArray

public T[] toArray()

Retrieves all entries that are in this bag.

Specified by:

toArray in interface BagInterface<T>

Returns:

A newly allocated array of all the entries in this bag.

getFrequencyOf

public int getFrequencyOf(T anEntry)

Counts the number of times a given entry appears in this bag.

Specified by:

getFrequencyOf in interface BagInterface<T>

Parameters:

anEntry - The entry to be counted.

Returns:

The number of times anEntry appears in this bag.

contains

public boolean contains(T anEntry)

Tests whether this bag contains a given entry.

Specified by:

contains in interface BagInterface<T>

Parameters:

anEntry - The entry to locate.

Returns:

True if the bag contains anEntry, or false otherwise.

clear

public void clear()

Removes all entries from this bag.

Specified by:

clear in interface BagInterface<T>

remove

public T remove()

Removes one unspecified entry from this bag, if possible.

Specified by:

remove in interface BagInterface<T>

Returns:

Either the removed entry, if the removal was successful, or null.

remove

public boolean remove(T anEntry)

Removes one occurrence of a given entry from this bag, if possible.

Specified by:

remove in interface BagInterface<T>

Parameters:

anEntry - The entry to be removed.

Returns:

True if the removal was successful, or false otherwise.