org.jgroups
Class Membership
- Cloneable
public class Membership
extends java.lang.Object
implements Cloneable
Class to keep track of Addresses.
The membership object holds a vector of Address objects that are in the same membership.
Each unique address can only exist once; i.e., doing Membership.add(existing_address)
will be ignored.
Membership() - Public constructor
Creates a member ship object with zero members
|
Membership(Collection initial_members) - Creates a member ship object with the initial members.
|
void | add(Collection v) - Adds a list of members to this membership
|
void | add(Address new_member) - Adds a new member to this membership.
|
void | clear() - removes all the members from this membership
|
Object | clone()
|
boolean | contains(Address member) - Returns true if the provided member belongs to this membership
|
Membership | copy() - returns a copy of this membership
|
Object | elementAt(int index) - Returns the component at the specified index
|
Vector | getMembers() - returns a copy (clone) of the members in this membership.
|
void | merge(Collection new_mems, Collection suspects) - merges membership with the new members and removes suspects
The Merge method will remove all the suspects and add in the new members.
|
void | remove(Collection v) - removes all the members contained in v from this membership
|
void | remove(Address old_member) - removes an member from the membership.
|
void | set(Collection v) - Clear the membership and adds all members of v
This method will clear out all the old members of this membership by
invoking the
Clear method.
|
void | set(Membership m) - Clear the membership and adds all members of v
This method will clear out all the old members of this membership by
invoking the
Clear method.
|
int | size() - Returns the number of addresses in this membership
|
void | sort()
|
String | toString()
|
log
protected static final Log log
Membership
public Membership()
Public constructor
Creates a member ship object with zero members
Membership
public Membership(Collection initial_members)
Creates a member ship object with the initial members.
The Address references are copied out of the vector, so that the
vector passed in as parameters is not the same reference as the vector
that the membership class is using
initial_members
- - a list of members that belong to this membership
add
public void add(Collection v)
Adds a list of members to this membership
v
- - a vector containing Address objects
add
public void add(Address new_member)
Adds a new member to this membership.
If the member already exist (Address.equals(Object) returns true then the member will
not be added to the membership
clear
public void clear()
removes all the members from this membership
clone
public Object clone()
- a clone of this object. The list of members is copied to a new
container
contains
public boolean contains(Address member)
Returns true if the provided member belongs to this membership
- true if the member belongs to this membership
copy
public Membership copy()
returns a copy of this membership
- an exact copy of this membership
elementAt
public Object elementAt(int index)
Returns the component at the specified index
java.util.Vector.elementAt
getMembers
public Vector getMembers()
returns a copy (clone) of the members in this membership.
the vector returned is immutable in reference to this object.
ie, modifying the vector that is being returned in this method
will not modify this membership object.
merge
public void merge(Collection new_mems,
Collection suspects)
merges membership with the new members and removes suspects
The Merge method will remove all the suspects and add in the new members.
It will do it in the order
1. Remove suspects
2. Add new members
the order is very important to notice.
new_mems
- - a vector containing a list of members (Address) to be added to this membershipsuspects
- - a vector containing a list of members (Address) to be removed from this membership
remove
public void remove(Collection v)
removes all the members contained in v from this membership
v
- - a vector containing all the members to be removed
remove
public void remove(Address old_member)
removes an member from the membership.
If this member doesn't exist, no action will be performed on the existing membership
old_member
- - the member to be removed
set
public void set(Collection v)
Clear the membership and adds all members of v
This method will clear out all the old members of this membership by
invoking the Clear
method.
Then it will add all the all members provided in the vector v
v
- - a vector containing all the members this membership will contain
set
public void set(Membership m)
Clear the membership and adds all members of v
This method will clear out all the old members of this membership by
invoking the Clear
method.
Then it will add all the all members provided in the vector v
m
- - a membership containing all the members this membership will contain
size
public int size()
Returns the number of addresses in this membership
- the number of addresses in this membership
toString
public String toString()
Copyright B) 1998-2005 Bela Ban. All Rights Reserved.