BoxList (box-content-sdk 3.0.4 API)

java.lang.Object
- com.box.androidsdk.content.models.BoxObject
- - com.box.androidsdk.content.models.BoxJsonObject
  - - com.box.androidsdk.content.models.BoxList<E>

Type Parameters:

E - the type of elements in this partial collection.

All Implemented Interfaces:

java.io.Serializable, java.lang.Iterable<E>, java.util.Collection<E>

Direct Known Subclasses:

BoxListCollaborations, BoxListCollections, BoxListComments, BoxListEnterpriseEvents, BoxListEvents, BoxListFileVersions, BoxListItems, BoxListOrders, BoxListRealTimeServers, BoxListUsers
```
public class BoxList<E extends BoxJsonObject>
extends BoxJsonObject
implements java.util.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.

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`protected java.util.Collection<E>`	`collection`
`protected boolean`	`collectionInProperties`
`static java.lang.String`	`FIELD_ENTRIES`
`static java.lang.String`	`FIELD_LIMIT`
`static java.lang.String`	`FIELD_OFFSET`
`static java.lang.String`	`FIELD_ORDER`
`static java.lang.String`	`FIELD_TOTAL_COUNT`

Fields inherited from class com.box.androidsdk.content.models.BoxJsonObject
mProperties

Constructor Summary

Constructors
Constructor and Description

BoxList()

BoxList(java.util.Map<java.lang.String,java.lang.Object> map)
Constructs a BoxList with the provided map values.

Constructors
Constructor and Description
`BoxList()`
`BoxList(java.util.Map<java.lang.String,java.lang.Object> map)` Constructs a BoxList with the provided map values.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`add(E e)`
`boolean`	`addAll(java.util.Collection<? extends E> c)`
`protected void`	`addCollectionToProperties()` Add the collection to the properties map if this has not been added already.
`void`	`clear()`
`boolean`	`contains(java.lang.Object o)`
`boolean`	`containsAll(java.util.Collection<?> c)`
`boolean`	`equals(java.lang.Object o)`
`java.lang.Long`	`fullSize()` Gets the size of the full collection that this partial collection is based off of.
`E`	`get(int index)`
`java.util.ArrayList<BoxOrder>`	`getSortOrders()`
`int`	`hashCode()`
`boolean`	`isEmpty()`
`java.util.Iterator<E>`	`iterator()`
`java.lang.Long`	`limit()` Gets the maximum number of items within the full collection that begin at `offset()`.
`java.lang.Long`	`offset()` Gets the offset within the full collection where this collection's items begin.
`protected void`	`parseJSONMember(com.eclipsesource.json.JsonObject.Member member)` Invoked with a JSON member whenever this object is updated or created from a JSON object.
`protected com.eclipsesource.json.JsonValue`	`parseJsonObject(java.util.Map.Entry<java.lang.String,java.lang.Object> entry)`
`boolean`	`remove(java.lang.Object o)`
`boolean`	`removeAll(java.util.Collection<?> c)`
`boolean`	`retainAll(java.util.Collection<?> c)`
`int`	`size()`
`java.lang.Object[]`	`toArray()`
`<T> T[]`	`toArray(T[] a)`

Methods inherited from class com.box.androidsdk.content.models.BoxJsonObject
createFromJson, createFromJson, getPropertiesAsHashMap, parseNullJsonMember, toJson, toJsonObject

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.util.Collection
parallelStream, removeIf, spliterator, stream

Methods inherited from interface java.lang.Iterable
forEach

- Field Detail
  - collection
```
protected final java.util.Collection<E extends BoxJsonObject> collection
```
  - collectionInProperties
```
protected transient boolean collectionInProperties
```
  - FIELD_ORDER
```
public static final java.lang.String FIELD_ORDER
```
    See Also:
    
    Constant Field Values
  - FIELD_TOTAL_COUNT
```
public static final java.lang.String FIELD_TOTAL_COUNT
```
    See Also:
    
    Constant Field Values
  - FIELD_ENTRIES
```
public static final java.lang.String FIELD_ENTRIES
```
    See Also:
    
    Constant Field Values
  - FIELD_OFFSET
```
public static final java.lang.String FIELD_OFFSET
```
    See Also:
    
    Constant Field Values
  - FIELD_LIMIT
```
public static final java.lang.String FIELD_LIMIT
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - BoxList
```
public BoxList()
```
  - BoxList
```
public BoxList(java.util.Map<java.lang.String,java.lang.Object> map)
```
    Constructs a BoxList with the provided map values.
    
    Parameters:
    
    map - map of keys and values of the object.
- Method Detail
  - addCollectionToProperties
```
protected void addCollectionToProperties()
```
    Add the collection to the properties map if this has not been added already.
  - offset
```
public java.lang.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 java.lang.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 java.lang.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.
  - parseJSONMember
```
protected void parseJSONMember(com.eclipsesource.json.JsonObject.Member member)
```
    Description copied from class: BoxJsonObject
    
    Invoked with a JSON member whenever this object is updated or created from a JSON object.
    Subclasses should override this method in order to parse any JSON members it knows about. This method is a no-op by default.
    
    Overrides:
    
    parseJSONMember in class BoxJsonObject
    
    Parameters:
    
    member - the JSON member to be parsed.
  - parseJsonObject
```
protected com.eclipsesource.json.JsonValue parseJsonObject(java.util.Map.Entry<java.lang.String,java.lang.Object> entry)
```
    Overrides:
    
    parseJsonObject in class BoxJsonObject
  - add
```
public boolean add(E e)
```
    Specified by:
    
    add in interface java.util.Collection<E extends BoxJsonObject>
  - addAll
```
public boolean addAll(java.util.Collection<? extends E> c)
```
    Specified by:
    
    addAll in interface java.util.Collection<E extends BoxJsonObject>
  - clear
```
public void clear()
```
    Specified by:
    
    clear in interface java.util.Collection<E extends BoxJsonObject>
  - contains
```
public boolean contains(java.lang.Object o)
```
    Specified by:
    
    contains in interface java.util.Collection<E extends BoxJsonObject>
  - containsAll
```
public boolean containsAll(java.util.Collection<?> c)
```
    Specified by:
    
    containsAll in interface java.util.Collection<E extends BoxJsonObject>
  - equals
```
public boolean equals(java.lang.Object o)
```
    Specified by:
    
    equals in interface java.util.Collection<E extends BoxJsonObject>
    
    Overrides:
    
    equals in class java.lang.Object
  - hashCode
```
public int hashCode()
```
    Specified by:
    
    hashCode in interface java.util.Collection<E extends BoxJsonObject>
    
    Overrides:
    
    hashCode in class java.lang.Object
  - isEmpty
```
public boolean isEmpty()
```
    Specified by:
    
    isEmpty in interface java.util.Collection<E extends BoxJsonObject>
  - iterator
```
public java.util.Iterator<E> iterator()
```
    Specified by:
    
    iterator in interface java.lang.Iterable<E extends BoxJsonObject>
    
    Specified by:
    
    iterator in interface java.util.Collection<E extends BoxJsonObject>
  - remove
```
public boolean remove(java.lang.Object o)
```
    Specified by:
    
    remove in interface java.util.Collection<E extends BoxJsonObject>
  - removeAll
```
public boolean removeAll(java.util.Collection<?> c)
```
    Specified by:
    
    removeAll in interface java.util.Collection<E extends BoxJsonObject>
  - retainAll
```
public boolean retainAll(java.util.Collection<?> c)
```
    Specified by:
    
    retainAll in interface java.util.Collection<E extends BoxJsonObject>
  - size
```
public int size()
```
    Specified by:
    
    size in interface java.util.Collection<E extends BoxJsonObject>
  - toArray
```
public java.lang.Object[] toArray()
```
    Specified by:
    
    toArray in interface java.util.Collection<E extends BoxJsonObject>
  - toArray
```
public <T> T[] toArray(T[] a)
```
    Specified by:
    
    toArray in interface java.util.Collection<E extends BoxJsonObject>
  - get
```
public E get(int index)
```
  - getSortOrders
```
public java.util.ArrayList<BoxOrder> getSortOrders()
```

Class BoxList<E extends BoxJsonObject>

Field Summary

Fields inherited from class com.box.androidsdk.content.models.BoxJsonObject

Constructor Summary

Method Summary

Methods inherited from class com.box.androidsdk.content.models.BoxJsonObject

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Collection

Methods inherited from interface java.lang.Iterable

Field Detail

collection

collectionInProperties

FIELD_ORDER

FIELD_TOTAL_COUNT

FIELD_ENTRIES

FIELD_OFFSET

FIELD_LIMIT

Constructor Detail

BoxList

BoxList

Method Detail

addCollectionToProperties

offset

limit

fullSize

parseJSONMember

parseJsonObject

add

addAll

clear

contains

containsAll

equals

hashCode

isEmpty

iterator

remove

removeAll

retainAll

size

toArray

toArray

get

getSortOrders