net.sf.hajdbc.balancer

Class AbstractSetBalancer<Z,D extends Database<Z>>

java.lang.Object

net.sf.hajdbc.balancer.AbstractBalancer<Z,D>

net.sf.hajdbc.balancer.AbstractSetBalancer<Z,D>

All Implemented Interfaces:

Iterable<D>, Collection<D>, Set<D>, Balancer<Z,D>

Direct Known Subclasses:

RandomBalancer, RoundRobinBalancer, SimpleBalancer

public abstract class AbstractSetBalancer<Z,D extends Database<Z>>
extends AbstractBalancer<Z,D>

Abstract set-based Balancer implementation.

Author:

Paul Ferraro

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractSetBalancer(Set<D> databases)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	add(D database)
boolean	addAll(Collection<? extends D> databases)
protected abstract void	added(D database) Called when a database was added to the set.
void	clear()
protected abstract void	cleared() Called when the set was cleared.
protected Set<D>	getDatabases()
protected Lock	getLock()
<T,R,E extends Exception> R	invoke(Invoker<Z,D,T,R,E> invoker, D database, T object) Invoke the specified invoker on the specified object against the specified database, potentially informing the balancer.
D	primary() Returns the primary database.
boolean	remove(Object database)
boolean	removeAll(Collection<?> databases)
protected abstract void	removed(D database) Called when a database was removed from the set.
boolean	retainAll(Collection<?> databases)

Methods inherited from class net.sf.hajdbc.balancer.AbstractBalancer

backups, contains, containsAll, equals, hashCode, isEmpty, iterator, size, toArray, toArray, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface net.sf.hajdbc.balancer.Balancer

next

Constructor Detail

AbstractSetBalancer

protected AbstractSetBalancer(Set<D> databases)

Method Detail

getLock

protected Lock getLock()

invoke

public <T,R,E extends Exception> R invoke(Invoker<Z,D,T,R,E> invoker,
                                 D database,
                                 T object)
         throws E extends Exception

Invoke the specified invoker on the specified object against the specified database, potentially informing the balancer.

Type Parameters:

T - invoker target object type

R - invoker return type

E - invoker exception type

Returns:

the result of the invocation

Throws:

E

E extends Exception

See Also:

Balancer.invoke(net.sf.hajdbc.invocation.Invoker, net.sf.hajdbc.Database, java.lang.Object)

primary

public D primary()

Returns the primary database. The database returned by this method should be consistent across nodes.

Returns:

the primary database

See Also:

Balancer.primary()

getDatabases

protected Set<D> getDatabases()

Specified by:

getDatabases in class AbstractBalancer<Z,D extends Database<Z>>

See Also:

AbstractBalancer.getDatabases()

remove

public boolean remove(Object database)

See Also:

Set.remove(java.lang.Object)

removed

protected abstract void removed(D database)

Called when a database was removed from the set.

Parameters:

database - a database descriptor

add

public boolean add(D database)

See Also:

Set.add(java.lang.Object)

added

protected abstract void added(D database)

Called when a database was added to the set.

Parameters:

database - a database descriptor

addAll

public boolean addAll(Collection<? extends D> databases)

See Also:

Set.addAll(java.util.Collection)

removeAll

public boolean removeAll(Collection<?> databases)

See Also:

Set.removeAll(java.util.Collection)

retainAll

public boolean retainAll(Collection<?> databases)

See Also:

Set.retainAll(java.util.Collection)

clear

public void clear()

See Also:

Set.clear()

cleared

protected abstract void cleared()

Called when the set was cleared.