@PublicAPI(stability=VOLATILE, mayInstantiate=false, mayExtend=true, mayInvoke=true) public abstract class MemberList extends Object implements Closeable
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 and Description |
---|
MemberList() |
Modifier and Type | Method and Description |
---|---|
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.
|
org.forgerock.opendj.ldap.Dn |
nextMemberDN()
Retrieves the DN of the next group member.
|
abstract Entry |
nextMemberEntry()
Retrieves the entry for the next group member.
|
public MemberList()
public abstract boolean hasMoreMembers()
true
if the group has at least one more member,
or false
if not.public org.forgerock.opendj.ldap.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
.close
in interface Closeable
close
in interface AutoCloseable
Copyright © 2010-2017 ForgeRock AS. All Rights Reserved.