Class Bag

java.lang.Object

Bag

public class Bag
extends java.lang.Object

A bag is a collection of unordered elements

Version:

11/24/14

Author:

Chris Fernandes

Constructor Summary

Constructors

Constructor and Description
Bag(int capacity) non-default constructor

Method Summary

Methods

Modifier and Type	Method and Description
void	add(java.lang.String value) inserts a new String into this Bag
int	capacity() Returns amount of space this bag has
void	clear() Empties out Bag
boolean	contains(java.lang.String value) Determines if Bag contains the specified string
Bag	copy() Return a bag that is an exact duplicate of this Bag
boolean	equals(Bag otherBag) Returns True if this Bag is equal to Bag given in parameter.
boolean	isEmpty() Returns True if Bag empty; else returns False
void	remove(java.lang.String value) Deletes specified string from Bag.
java.lang.String	removeRandom() Remove and returns a random string from the Bag.
int	size() Returns number of strings in Bag
java.lang.String	toString() Returns Bag as a printable String
void	trimToSize() Make this Bag's capacity equal to its size
Bag	union(Bag otherBag) Return union of this Bag and Bag specified in parameter

Methods inherited from class java.lang.Object

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

Constructor Detail

Bag

public Bag(int capacity)

non-default constructor

Parameters:

capacity - amount of storage space this bag has

Method Detail

add

public void add(java.lang.String value)

inserts a new String into this Bag

Parameters:

value - string to be inserted

remove

public void remove(java.lang.String value)

Deletes specified string from Bag. Does nothing if string not present.

Parameters:

value - string to remove

contains

public boolean contains(java.lang.String value)

Determines if Bag contains the specified string

Parameters:

value - string to search for

Returns:

True if Bag contains specified String; else returns False

isEmpty

public boolean isEmpty()

Returns True if Bag empty; else returns False

clear

public void clear()

Empties out Bag

size

public int size()

Returns number of strings in Bag

toString

public java.lang.String toString()

Returns Bag as a printable String

Overrides:

toString in class java.lang.Object

capacity

public int capacity()

Returns amount of space this bag has

removeRandom

public java.lang.String removeRandom()

Remove and returns a random string from the Bag. Returns null if Bag empty.

equals

public boolean equals(Bag otherBag)

Returns True if this Bag is equal to Bag given in parameter. Else returns False.

Parameters:

otherBag - bag to compare to this bag

Returns:

True if both bags have same number of elements and all elements are the same in both bags. Equal capacity is not a prerequisite for equal bags.

copy

public Bag copy()

Return a bag that is an exact duplicate of this Bag

trimToSize

public void trimToSize()

Make this Bag's capacity equal to its size

union

public Bag union(Bag otherBag)

Return union of this Bag and Bag specified in parameter