PrincipalIteratorAdapter (Oak Security SPI 1.42.0 API)

java.lang.Object
- org.apache.jackrabbit.commons.iterator.RangeIteratorDecorator
- - org.apache.jackrabbit.oak.spi.security.principal.PrincipalIteratorAdapter

All Implemented Interfaces:

java.util.Iterator, RangeIterator, org.apache.jackrabbit.api.security.principal.PrincipalIterator
```
public class PrincipalIteratorAdapter
extends RangeIteratorDecorator
implements org.apache.jackrabbit.api.security.principal.PrincipalIterator
```
Principal specific RangeIteratorAdapter implementing the PrincipalIterator interface.

Field Summary

Fields
Modifier and Type Field Description

static PrincipalIteratorAdapter EMPTY
Static instance of an empty PrincipalIterator.

Constructor Summary

Constructors
Constructor	Description
`PrincipalIteratorAdapter(java.util.Collection<? extends java.security.Principal> collection)`	Creates an iterator for the given collection of `Principal`s.
`PrincipalIteratorAdapter(java.util.Iterator<? extends java.security.Principal> iterator)`	Creates an adapter for the given `Iterator` of principals.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type Method Description

@NotNull java.security.Principal nextPrincipal()
Returns the next policy.
- Methods inherited from class org.apache.jackrabbit.commons.iterator.RangeIteratorDecorator
  getPosition, getSize, hasNext, next, remove, skip
- Methods inherited from class java.lang.Object
  clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
- Methods inherited from interface java.util.Iterator
  forEachRemaining, hasNext, next, remove
- Methods inherited from interface javax.jcr.RangeIterator
  getPosition, getSize, skip

- Field Detail
  - EMPTY
```
public static final PrincipalIteratorAdapter EMPTY
```
    Static instance of an empty PrincipalIterator.
- Constructor Detail
  - PrincipalIteratorAdapter
```
public PrincipalIteratorAdapter(java.util.Iterator<? extends java.security.Principal> iterator)
```
    Creates an adapter for the given Iterator of principals.
    
    Parameters:
    
    iterator - iterator of Principals
  - PrincipalIteratorAdapter
```
public PrincipalIteratorAdapter(java.util.Collection<? extends java.security.Principal> collection)
```
    Creates an iterator for the given collection of Principals.
    
    Parameters:
    
    collection - collection of Principal objects.
- Method Detail
  - nextPrincipal
```
@NotNull
public @NotNull java.security.Principal nextPrincipal()
```
    Returns the next policy.
    
    Specified by:
    
    nextPrincipal in interface org.apache.jackrabbit.api.security.principal.PrincipalIterator
    
    Returns:
    
    next policy.