com.box.sdk

Class PartialCollection<E>

Object

PartialCollection<E>

Type Parameters:

E - the type of elements in this partial collection.

All Implemented Interfaces:

Iterable<E>, Collection<E>

public class PartialCollection<E>
extends Object
implements Collection<E>

A collection that contains a subset of items that are a part of a larger collection. The items within a partial collection begin at an offset within the full collection and end at a specified limit. Note that the actual size of a partial collection may be less than its limit since the limit only specifies the maximum size. For example, if there's a full collection with a size of 3, then a partial collection with offset 0 and limit 3 would be equal to a partial collection with offset 0 and limit 100.

Constructor Summary

Constructors

Constructor and Description
PartialCollection(long offset, long limit, long fullSize) Constructs a PartialCollection with a specified offset, limit, and full size.

Method Summary

Modifier and Type	Method and Description
boolean	add(E e)
boolean	addAll(Collection<? extends E> c)
void	clear()
boolean	contains(Object o)
boolean	containsAll(Collection<?> c)
boolean	equals(Object o)
long	fullSize() Gets the size of the full collection that this partial collection is based off of.
int	hashCode()
boolean	isEmpty()
Iterator<E>	iterator()
long	limit() Gets the maximum number of items within the full collection that begin at offset.
long	offset() Gets the offset within the full collection where this collection's items begin.
boolean	remove(Object o)
boolean	removeAll(Collection<?> c)
boolean	retainAll(Collection<?> c)
int	size()
Object[]	toArray()
<T> T[]	toArray(T[] a)

Methods inherited from class Object

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

Methods inherited from interface Collection

parallelStream, removeIf, spliterator, stream

Methods inherited from interface Iterable

forEach

Constructor Detail

PartialCollection

public PartialCollection(long offset,
                         long limit,
                         long fullSize)

Constructs a PartialCollection with a specified offset, limit, and full size.

Parameters:

offset - the offset within in the full collection.

limit - the maximum number of items after the offset.

fullSize - the total number of items in the full collection.

Method Detail

offset

public long offset()

Gets the offset within the full collection where this collection's items begin.

Returns:

the offset within the full collection where this collection's items begin.

limit

public long limit()

Gets the maximum number of items within the full collection that begin at offset.

Returns:

the maximum number of items within the full collection that begin at the offset.

fullSize

public long fullSize()

Gets the size of the full collection that this partial collection is based off of.

Returns:

the size of the full collection that this partial collection is based off of.

add

public boolean add(E e)

Specified by:

add in interface Collection<E>

addAll

public boolean addAll(Collection<? extends E> c)

Specified by:

addAll in interface Collection<E>

clear

public void clear()

Specified by:

clear in interface Collection<E>

contains

public boolean contains(Object o)

Specified by:

contains in interface Collection<E>

containsAll

public boolean containsAll(Collection<?> c)

Specified by:

containsAll in interface Collection<E>

equals

public boolean equals(Object o)

Specified by:

equals in interface Collection<E>

Overrides:

equals in class Object

hashCode

public int hashCode()

Specified by:

hashCode in interface Collection<E>

Overrides:

hashCode in class Object

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface Collection<E>

iterator

public Iterator<E> iterator()

Specified by:

iterator in interface Iterable<E>

Specified by:

iterator in interface Collection<E>

remove

public boolean remove(Object o)

Specified by:

remove in interface Collection<E>

removeAll

public boolean removeAll(Collection<?> c)

Specified by:

removeAll in interface Collection<E>

retainAll

public boolean retainAll(Collection<?> c)

Specified by:

retainAll in interface Collection<E>

size

public int size()

Specified by:

size in interface Collection<E>

toArray

public Object[] toArray()

Specified by:

toArray in interface Collection<E>

toArray

public <T> T[] toArray(T[] a)

Specified by:

toArray in interface Collection<E>