com.jivesoftware.base
Class UserGroupIteratorProxy

java.lang.Object
  com.jivesoftware.base.UserGroupIteratorProxy

All Implemented Interfaces:

java.util.Iterator

public class UserGroupIteratorProxy
extends java.lang.Object
implements java.util.Iterator

Protection proxy for Iterators of users and groups. The class is also smart enough to skip over elements in the Iterator that the user doesn't have permission to read.

Constructor Summary

UserGroupIteratorProxy(int type, java.util.Iterator iterator, AuthToken auth, Permissions permissions)
Creates a new iterator proxy.

Method Summary

java.lang.Object	getNextElement() Returns the next available element, or null if there are no more elements.
boolean	hasNext() Returns true if there are more elements in the iteration.
java.lang.Object	next() Returns the next element.
void	remove() Not supported for security reasons.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

UserGroupIteratorProxy

public UserGroupIteratorProxy(int type,
                              java.util.Iterator iterator,
                              AuthToken auth,
                              Permissions permissions)

Creates a new iterator proxy.

Parameters:

type - the type of object to be proxied. Must be a valid value from JiveConstants.

iterator - the Iterator to create proxies for.

auth - the authorization token.

permissions - the permissions that the new proxy will inherit.

Method Detail

hasNext

public boolean hasNext()

Returns true if there are more elements in the iteration.

Specified by:

hasNext in interface java.util.Iterator

Returns:

true if the iterator has more elements.

next

public java.lang.Object next()
                      throws java.util.NoSuchElementException

Returns the next element.

Specified by:

next in interface java.util.Iterator

Returns:

the next element.

Throws:

java.util.NoSuchElementException - if there are no more elements.

remove

public void remove()
            throws java.lang.UnsupportedOperationException

Not supported for security reasons.

Specified by:

remove in interface java.util.Iterator

Throws:

java.lang.UnsupportedOperationException

getNextElement

public java.lang.Object getNextElement()

Returns the next available element, or null if there are no more elements.

Returns:

the next available element.