|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.opends.server.types.MemberList
@PublicAPI(stability=VOLATILE, mayInstantiate=false, mayExtend=true, mayInvoke=true) public abstract class MemberList
This class defines a mechanism that may be used to iterate over the
members of a group. It uses an interface that is similar to that
of java.util.Iterator
, but is specific to group membership
and that provides the ability to throw an exception when attempting
to retrieve the next member (e.g., if the group contains a
malformed DN or references a member that doesn't exist).
Constructor Summary | |
---|---|
MemberList()
|
Method Summary | |
---|---|
abstract void |
close()
Indicates that this member list is no longer required and that the server may clean up any resources that may have been used in the course of processing. |
abstract boolean |
hasMoreMembers()
Indicates whether the group contains any more members. |
DN |
nextMemberDN()
Retrieves the DN of the next group member. |
abstract Entry |
nextMemberEntry()
Retrieves the entry for the next group member. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public MemberList()
Method Detail |
---|
public abstract boolean hasMoreMembers()
true
if the group has at least one more member,
or false
if not.public DN nextMemberDN() throws MembershipException
null
if
there are no more members.
MembershipException
- If a problem occurs while
attempting to retrieve the next
member DN.public abstract Entry nextMemberEntry() throws MembershipException
null
if
there are no more members.
MembershipException
- If a problem occurs while
attempting to retrieve the next
entry.public abstract void close()
hasMoreMembers
returns false
.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |