com.cloudhopper.commons.util

Interface LoadBalancedList<E>

All Known Implementing Classes:

RoundRobinLoadBalancedList

public interface LoadBalancedList<E>

A list that can act like a load balancer by internally tracking which item to return next.

Author:

joelauer (twitter: @jjlauer or http://twitter.com/jjlauer)

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	LoadBalancedList.Node<E>

Method Summary

Methods

Modifier and Type	Method and Description
void	clear() Clears all entries from the list.
boolean	contains(E item) Checks if the item is already contained in this list.
E	getNext() Gets the next item to use from the list.
int	getSize() Gets the total number of items (size) of the list.
List<LoadBalancedList.Node<E>>	getValues() Gets a list of all nodes.
void	remove(E item) Removes an item from the list.
void	set(E item, int weight) Adds the item to the list if it doesn't yet exist.

Method Detail

getValues

List<LoadBalancedList.Node<E>> getValues()

Gets a list of all nodes.

Returns:

A list of all nodes.

clear

void clear()

Clears all entries from the list.

contains

boolean contains(E item)

Checks if the item is already contained in this list.

Parameters:

item - The item to check for in list

Returns:

True if in list, or false if its not found.

getNext

E getNext()

Gets the next item to use from the list.

Returns:

The next item to use or null if no items were available.

getSize

int getSize()

Gets the total number of items (size) of the list.

Returns:

The size of the list (number of items)

remove

void remove(E item)

Removes an item from the list. If the item doesn't exist, this method will do nothing.

Parameters:

item - The item to remove.

set

void set(E item,
       int weight)

Adds the item to the list if it doesn't yet exist. If the item is already in the list, then this method will update the weight of the item.

Parameters:

item - The item to add or set

weight - The new weight of the item