com.box.sdk

Class BoxCollection

Object

BoxResource

BoxCollection

All Implemented Interfaces:

Iterable<BoxItem.Info>

@BoxResourceType(value="collection")
public class BoxCollection
extends BoxResource
implements Iterable<BoxItem.Info>

Collections contain information about the items contained inside of them, including files and folders. The only collection available currently is a “Favorites” collection.

Unless otherwise noted, the methods in this class can throw an unchecked BoxAPIException (unchecked meaning that the compiler won't force you to handle it) if an error occurs. If you wish to implement custom error handling for errors related to the Box REST API, you should capture this exception explicitly.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	BoxCollection.Info Contains information about a BoxCollection.

Field Summary

Fields

Modifier and Type	Field and Description
static URLTemplate	GET_COLLECTION_ITEMS_URL Get Collection Items URL Template.
static URLTemplate	GET_COLLECTIONS_URL_TEMPLATE Get Collections URL Template.

Constructor Summary

Constructors

Constructor and Description
BoxCollection(BoxAPIConnection api, String id) Constructs a BoxCollection for a collection with a given ID.

Method Summary

Modifier and Type	Method and Description
static Iterable<BoxCollection.Info>	getAllCollections(BoxAPIConnection api) Gets an iterable of all the collections for the given user.
Iterable<BoxItem.Info>	getItems() Returns an iterable containing the items in this collection.
Iterable<BoxItem.Info>	getItems(String... fields) Returns an iterable containing the items in this collection and specifies which attributes to include in the response.
PartialCollection<BoxItem.Info>	getItemsRange(long offset, long limit, String... fields) Retrieves a specific range of items in this collection.
Iterator<BoxItem.Info>	iterator() Returns an iterator over the items in this collection.

Methods inherited from class BoxResource

equals, getAPI, getID, getResourceType, hashCode

Methods inherited from class Object

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

Methods inherited from interface Iterable

forEach, spliterator

Field Detail

GET_COLLECTIONS_URL_TEMPLATE

public static final URLTemplate GET_COLLECTIONS_URL_TEMPLATE

Get Collections URL Template.

GET_COLLECTION_ITEMS_URL

public static final URLTemplate GET_COLLECTION_ITEMS_URL

Get Collection Items URL Template.

Constructor Detail

BoxCollection

public BoxCollection(BoxAPIConnection api,
                     String id)

Constructs a BoxCollection for a collection with a given ID.

Parameters:

api - the API connection to be used by the collection.

id - the ID of the collection.

Method Detail

getAllCollections

public static Iterable<BoxCollection.Info> getAllCollections(BoxAPIConnection api)

Gets an iterable of all the collections for the given user.

Parameters:

api - the API connection to be used when retrieving the collections.

Returns:

an iterable containing info about all the collections.

getItems

public Iterable<BoxItem.Info> getItems()

Returns an iterable containing the items in this collection. Iterating over the iterable returned by this method is equivalent to iterating over this BoxCollection directly.

Returns:

an iterable containing the items in this collection.

getItems

public Iterable<BoxItem.Info> getItems(String... fields)

Returns an iterable containing the items in this collection and specifies which attributes to include in the response.

Parameters:

fields - the fields to retrieve.

Returns:

an iterable containing the items in this collection.

getItemsRange

public PartialCollection<BoxItem.Info> getItemsRange(long offset,
                                                     long limit,
                                                     String... fields)

Retrieves a specific range of items in this collection.

Parameters:

offset - the index of the first item to retrieve.

limit - the maximum number of items to retrieve after the offset.

fields - the fields to retrieve.

Returns:

a partial collection containing the specified range of items.

iterator

public Iterator<BoxItem.Info> iterator()

Returns an iterator over the items in this collection.

Specified by:

iterator in interface Iterable<BoxItem.Info>

Returns:

an iterator over the items in this collection.