org.agorava.api.storage

Interface Repository<T extends Identifiable>

Type Parameters:

T - the type of element contained in repo

All Superinterfaces:

Iterable<T>, Serializable

All Known Subinterfaces:

GlobalRepository, UserSessionRepository

public interface Repository<T extends Identifiable>
extends Serializable, Iterable<T>

A repository containing a collection of element that can be iterated

Author:

Antoine Sabot-Durand

Method Summary

Methods

Modifier and Type	Method and Description
void	add(T element) Add the given element
T	get(String id) Return element with the given id
Collection<T>	getAll()
T	getCurrent()
boolean	remove(String id) Remove the element with the given id
boolean	remove(T element) Remove the given element
boolean	removeCurrent() Remove the current Element
T	setCurrent(String id) Look for element with the given id, set it as current and return it
void	setCurrent(T element) Set the current element

Methods inherited from interface java.lang.Iterable

iterator

Method Detail

getCurrent

T getCurrent()

Returns:

the current element

getAll

Collection<T> getAll()

Returns:

all elements in this Repository

setCurrent

void setCurrent(T element)

Set the current element

Parameters:

element - to set as current

setCurrent

T setCurrent(String id)
                                  throws IllegalArgumentException

Look for element with the given id, set it as current and return it

Parameters:

id - od the element to set as current

Returns:

the element with the given id

Throws:

IllegalArgumentException - if no element with the given id is found

get

T get(String id)

Return element with the given id

Parameters:

id - a String id for the element

Returns:

the element with the given id or null if it doesn't exist

removeCurrent

boolean removeCurrent()

Remove the current Element

Returns:

true if it was removed correctly

remove

boolean remove(String id)

Remove the element with the given id

Parameters:

id - of the element to remove

Returns:

true if it was removed correctly

remove

boolean remove(T element)

Remove the given element

Parameters:

element - to remove

Returns:

true if it was removed correctly

add

void add(T element)

Add the given element

Parameters:

element - to add