Class MahFravrit<E>

java.lang.Object

MahFravrit<E>

Type Parameters:

E - the type of the items from which one seeks a fravrit (i.e. favorite)

public class MahFravrit<E>
extends java.lang.Object

MahFravrit ("MyFavorite") is a meme-influenced class that is defined according to a generic Comparator that expresses preference, takes in any number of items to be compared, and allows the user to request and remove a fravrit ("favorite") from the given set.

Constructor Summary

Constructors

Constructor and Description
MahFravrit(java.util.Comparator<E> fravriter) Create a new MahFravrit object with the given Comparator to discern mah fravrit ("my favorite") item of that type.

Method Summary

Modifier and Type	Method and Description
void	add(E item) Add an item to this set of items.
E	getFravrit() Find, remove, and return the fravrit ("favorite"), item in the set of items.
boolean	isEmpty() Return whether or not any items are contained.
boolean	remove(E item) Request to remove a given item from this set.

Methods inherited from class java.lang.Object

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

Constructor Detail

MahFravrit

public MahFravrit(java.util.Comparator<E> fravriter)

Create a new MahFravrit object with the given Comparator to discern mah fravrit ("my favorite") item of that type.

Parameters:

fravriter - a Comparator for determining a favorite item given two items of a type. A Comparator implements a compare method that takes two items as parameters, returns a positive/negative number if the first item is "greater"/"lesser" in some sense, respectively. If the two are equivalent, a zero value is returned.

Method Detail

isEmpty

public boolean isEmpty()

Return whether or not any items are contained.

Returns:

whether or not any items are contained

add

public void add(E item)

Add an item to this set of items.

Parameters:

item - the item to be added to this set

remove

public boolean remove(E item)

Request to remove a given item from this set.

Parameters:

item - the item requested to be removed

Returns:

whether or not the item was found and removed

getFravrit

public E getFravrit()

Find, remove, and return the fravrit ("favorite"), item in the set of items. This operation should not take more comparisons than the number of items contained.

Returns:

the current fravrit ("favorite") from among the items in the set, or null if there are no items