org.xwiki.extension.wrap

Class WrappingIterableResult<E extends Extension>

java.lang.Object

org.xwiki.script.wrap.AbstractWrappingObject<T>

org.xwiki.script.internal.safe.AbstractSafeObject<IterableResult<E>>

org.xwiki.extension.wrap.WrappingIterableResult<E>

Type Parameters:

E - the extension type

All Implemented Interfaces:

Iterable<E>, IterableResult<E>

public class WrappingIterableResult<E extends Extension>
extends org.xwiki.script.internal.safe.AbstractSafeObject<IterableResult<E>>
implements IterableResult<E>

Provide a public script access to a iterable result.

Since:

4.0M2

Version:

$Id: b83b4a300bacdfdffe1c1a35283666fa3b896954 $

Field Summary

Fields inherited from class org.xwiki.script.internal.safe.AbstractSafeObject

FORBIDDEN, safeProvider

Constructor Summary

Constructors

Constructor and Description
WrappingIterableResult(IterableResult<E> result, org.xwiki.script.internal.safe.ScriptSafeProvider<?> safeProvider)

Method Summary

Modifier and Type	Method and Description
int	getOffset()
int	getSize()
int	getTotalHits()
Iterator<E>	iterator()

Methods inherited from class org.xwiki.script.internal.safe.AbstractSafeObject

safe

Methods inherited from class org.xwiki.script.wrap.AbstractWrappingObject

equals, getWrapped, hashCode, resolveWrapped, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

WrappingIterableResult

public WrappingIterableResult(IterableResult<E> result,
                              org.xwiki.script.internal.safe.ScriptSafeProvider<?> safeProvider)

Parameters:

result - the wrapped result

safeProvider - the provider of instances safe for public scripts

Method Detail

iterator

public Iterator<E> iterator()

Specified by:

iterator in interface Iterable<E extends Extension>

getTotalHits

public int getTotalHits()

Specified by:

getTotalHits in interface IterableResult<E extends Extension>

Returns:

the total number of possible results without offset or maximum results limits

getOffset

public int getOffset()

Specified by:

getOffset in interface IterableResult<E extends Extension>

Returns:

the index in the total number of possible search result where this extract starts

getSize

public int getSize()

Specified by:

getSize in interface IterableResult<E extends Extension>

Returns:

the number of found extensions