Package org.jgroups
Class Membership
- java.lang.Object
-
- org.jgroups.Membership
-
- All Implemented Interfaces:
java.lang.Cloneable
public class Membership extends java.lang.Object implements java.lang.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.
-
-
Field Summary
Fields Modifier and Type Field Description protected static org.apache.commons.logging.Log
log
-
Constructor Summary
Constructors Constructor Description Membership()
Public constructor Creates a member ship object with zero membersMembership(java.util.Collection<Address> initial_members)
Creates a member ship object with the initial members.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
add(java.util.Collection<Address> v)
Adds a list of members to this membershipvoid
add(Address new_member)
Adds a new member to this membership.void
clear()
removes all the members from this membershipjava.lang.Object
clone()
boolean
contains(Address member)
Returns true if the provided member belongs to this membershipMembership
copy()
returns a copy of this membershipAddress
elementAt(int index)
Returns the component at the specified indexjava.util.Vector<Address>
getMembers()
returns a copy (clone) of the members in this membership.void
merge(java.util.Collection<Address> new_mems, java.util.Collection<Address> 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(java.util.Collection<Address> v)
removes all the members contained in v from this membershipvoid
remove(Address old_member)
removes an member from the membership.void
set(java.util.Collection<Address> v)
Clear the membership and adds all members of v This method will clear out all the old members of this membership by invoking theClear
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 theClear
method.int
size()
Returns the number of addresses in this membershipvoid
sort()
java.lang.String
toString()
-
-
-
Constructor Detail
-
Membership
public Membership()
Public constructor Creates a member ship object with zero members
-
Membership
public Membership(java.util.Collection<Address> 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- Parameters:
initial_members
- - a list of members that belong to this membership
-
-
Method Detail
-
getMembers
public java.util.Vector<Address> 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.- Returns:
- a list of members,
-
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
-
add
public final void add(java.util.Collection<Address> v)
Adds a list of members to this membership- Parameters:
v
- - a vector containing Address objects- Throws:
java.lang.ClassCastException
- if v contains objects that don't implement the Address interface- See Also:
add(org.jgroups.Address)
-
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- Parameters:
old_member
- - the member to be removed
-
remove
public void remove(java.util.Collection<Address> v)
removes all the members contained in v from this membership- Parameters:
v
- - a vector containing all the members to be removed
-
clear
public void clear()
removes all the members from this membership
-
set
public void set(java.util.Collection<Address> v)
Clear the membership and adds all members of v This method will clear out all the old members of this membership by invoking theClear
method. Then it will add all the all members provided in the vector v- Parameters:
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 theClear
method. Then it will add all the all members provided in the vector v- Parameters:
m
- - a membership containing all the members this membership will contain
-
merge
public void merge(java.util.Collection<Address> new_mems, java.util.Collection<Address> 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.- Parameters:
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
-
contains
public boolean contains(Address member)
Returns true if the provided member belongs to this membership- Parameters:
member
-- Returns:
- true if the member belongs to this membership
-
sort
public void sort()
-
copy
public Membership copy()
returns a copy of this membership- Returns:
- an exact copy of this membership
-
clone
public java.lang.Object clone()
- Overrides:
clone
in classjava.lang.Object
- Returns:
- a clone of this object. The list of members is copied to a new container
-
size
public int size()
Returns the number of addresses in this membership- Returns:
- the number of addresses in this membership
-
elementAt
public Address elementAt(int index)
Returns the component at the specified index- Parameters:
index
- - 0..size()-1- Throws:
java.lang.ArrayIndexOutOfBoundsException
- - if the index is negative or not less than the current size of this Membership object.- See Also:
Vector.elementAt(int)
-
toString
public java.lang.String toString()
- Overrides:
toString
in classjava.lang.Object
-
-