de.janrufmonitor.framework
Interface ICallerList

public interface ICallerList

This interface must be implemented by a caller list object, which should be used in the framework.

Author:

Thilo Brandt

Method Summary

void	add(ICaller caller) Add a caller to the list.
void	add(ICallerList callerList) Add a caller list to the list.
void	clear() Clears the list, means removes all elements.
boolean	contains(ICaller caller) Checks if a caller object is in this list.
ICaller	get(int position) Gets a caller with a certain position from the list.
void	remove(ICaller caller) Removes a caller from the list.
int	size() Gets the size of the list.
void	sort() Sorts the list with a default sort order.
void	sort(int order, boolean direction) Sorts the list with a defined sort order.
Object[]	toArray() Returns an object array of this list.

Method Detail

contains

boolean contains(ICaller caller)

Checks if a caller object is in this list.

Parameters:

caller - caller to be checked in this list.

Returns:

true if caller is in the list, if not false.

remove

void remove(ICaller caller)

Removes a caller from the list.

Parameters:

caller - caller to be removed from the list.

add

void add(ICaller caller)

Add a caller to the list.

Parameters:

caller - caller to be added to the list.

add

void add(ICallerList callerList)

Add a caller list to the list.

Parameters:

callerList - caller list to be added to the list.

get

ICaller get(int position)

Gets a caller with a certain position from the list.

Parameters:

position - position of the caller.

Returns:

a caller object or null if none was found.

sort

void sort()

Sorts the list with a default sort order.

sort

void sort(int order,
          boolean direction)

Sorts the list with a defined sort order.

Parameters:

order - the sort order.

direction - the direction, true ascending, false descending.

size

int size()

Gets the size of the list.

Returns:

size of the list.

clear

void clear()

Clears the list, means removes all elements.

toArray

Object[] toArray()

Returns an object array of this list.

Returns:

an object array of the list