BoxFolder (Box Java SDK)

Object
- BoxResource
- - BoxItem
  - - BoxFolder

All Implemented Interfaces:

Iterable<BoxItem.Info>
```
public final class BoxFolder
extends BoxItem
implements Iterable<BoxItem.Info>
```
Represents a folder on Box. This class can be used to iterate through a folder's contents, collaborate a folder with another user or group, and perform other common folder operations (move, copy, delete, etc.).

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`class`	`BoxFolder.Info` Contains information about a BoxFolder.
`static class`	`BoxFolder.Permission` Enumerates the possible permissions that a user can have on a folder.
`static class`	`BoxFolder.SyncState` Enumerates the possible sync states that a folder can have.

Field Summary

Fields
Modifier and Type Field and Description

static String[] ALL_FIELDS
An array of all possible folder fields that can be requested when calling getInfo().

Fields
Modifier and Type	Field and Description
`static String[]`	`ALL_FIELDS` An array of all possible folder fields that can be requested when calling `getInfo()`.

Constructor Summary

Constructors
Constructor and Description

BoxFolder(BoxAPIConnection api, String id)
Constructs a BoxFolder for a folder with a given ID.

Constructors
Constructor and Description
`BoxFolder(BoxAPIConnection api, String id)` Constructs a BoxFolder for a folder with a given ID.

Method Summary

Methods
Modifier and Type	Method and Description
`BoxCollaboration.Info`	`collaborate(BoxCollaborator collaborator, BoxCollaboration.Role role)` Adds a collaborator to this folder.
`BoxCollaboration.Info`	`collaborate(String email, BoxCollaboration.Role role)` Adds a collaborator to this folder.
`BoxFolder.Info`	`copy(BoxFolder destination)` Copies this item to another folder.
`BoxFolder.Info`	`copy(BoxFolder destination, String newName)` Copies this item to another folder and gives it a new name.
`BoxFolder.Info`	`createFolder(String name)` Creates a new child folder inside this folder.
`BoxSharedLink`	`createSharedLink(BoxSharedLink.Access access, Date unshareDate, BoxSharedLink.Permissions permissions)` Creates a new shared link for this item.
`void`	`delete(boolean recursive)` Deletes this folder, optionally recursively deleting all of its contents.
`Iterable<BoxItem.Info>`	`getChildren()` Returns an iterable containing the items in this folder.
`Iterable<BoxItem.Info>`	`getChildren(String... fields)` Returns an iterable containing the items in this folder and specifies which child fields to retrieve from the API.
`PartialCollection<BoxItem.Info>`	`getChildrenRange(long offset, long limit, String... fields)` Retrieves a specific range of child items in this folder.
`Collection<BoxCollaboration.Info>`	`getCollaborations()` Gets information about all of the collaborations for this folder.
`BoxFolder.Info`	`getInfo()` Gets information about this item.
`BoxFolder.Info`	`getInfo(String... fields)` Gets information about this item that's limited to a list of specified fields.
`static BoxFolder`	`getRootFolder(BoxAPIConnection api)` Gets the current user's root folder.
`Iterator<BoxItem.Info>`	`iterator()` Returns an iterator over the items in this folder.
`void`	`move(BoxFolder destination)` Moves this folder to another folder.
`void`	`rename(String newName)` Renames this folder.
`Iterable<BoxItem.Info>`	`search(String query)` Searches this folder and all descendant folders using a given query.
`void`	`updateInfo(BoxFolder.Info info)` Updates the information about this folder with any info fields that have been modified locally.
`BoxFile.Info`	`uploadFile(FileUploadParams uploadParams)` Uploads a new file to this folder with custom upload parameters.
`BoxFile.Info`	`uploadFile(InputStream fileContent, String name)` Uploads a new file to this folder.
`BoxFile.Info`	`uploadFile(InputStream fileContent, String name, long fileSize, ProgressListener listener)` Uploads a new file to this folder while reporting the progress to a ProgressListener.

Methods inherited from class BoxResource
equals, getAPI, getID, hashCode

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

- Field Detail
  - ALL_FIELDS
```
public static final String[] ALL_FIELDS
```
    An array of all possible folder fields that can be requested when calling getInfo().
- Constructor Detail
  - BoxFolder
```
public BoxFolder(BoxAPIConnection api,
         String id)
```
    Constructs a BoxFolder for a folder with a given ID.
    
    Parameters:
    api - the API connection to be used by the folder.
    id - the ID of the folder.
- Method Detail
  - getRootFolder
```
public static BoxFolder getRootFolder(BoxAPIConnection api)
```
    Gets the current user's root folder.
    
    Parameters:
    api - the API connection to be used by the folder.
    
    Returns:
    the user's root folder.
  - collaborate
```
public BoxCollaboration.Info collaborate(BoxCollaborator collaborator,
                                BoxCollaboration.Role role)
```
    Adds a collaborator to this folder.
    
    Parameters:
    collaborator - the collaborator to add.
    role - the role of the collaborator.
    
    Returns:
    info about the new collaboration.
  - collaborate
```
public BoxCollaboration.Info collaborate(String email,
                                BoxCollaboration.Role role)
```
    Adds a collaborator to this folder. An email will be sent to the collaborator if they don't already have a Box account.
    
    Parameters:
    email - the email address of the collaborator to add.
    role - the role of the collaborator.
    
    Returns:
    info about the new collaboration.
  - createSharedLink
```
public BoxSharedLink createSharedLink(BoxSharedLink.Access access,
                             Date unshareDate,
                             BoxSharedLink.Permissions permissions)
```
    Description copied from class: BoxItem
    
    Creates a new shared link for this item.
    This method is a convenience method for manually creating a new shared link and applying it to this item with BoxItem.Info.setSharedLink(com.box.sdk.BoxSharedLink). You may want to create the shared link manually so that it can be updated along with other changes to the item's info in a single network request, giving a boost to performance.
    
    Specified by:
    
    createSharedLink in class BoxItem
    
    Parameters:
    access - the access level of the shared link.
    unshareDate - the date and time at which the link will expire. Can be null to create a non-expiring link.
    permissions - the permissions of the shared link. Can be null to use the default permissions.
    
    Returns:
    the created shared link.
  - getCollaborations
```
public Collection<BoxCollaboration.Info> getCollaborations()
```
    Gets information about all of the collaborations for this folder.
    
    Returns:
    a collection of information about the collaborations for this folder.
  - getInfo
```
public BoxFolder.Info getInfo()
```
    Description copied from class: BoxItem
    
    Gets information about this item.
    
    Specified by:
    
    getInfo in class BoxItem
    
    Returns:
    info about this item.
  - getInfo
```
public BoxFolder.Info getInfo(String... fields)
```
    Description copied from class: BoxItem
    
    Gets information about this item that's limited to a list of specified fields.
    
    Specified by:
    
    getInfo in class BoxItem
    
    Parameters:
    fields - the fields to retrieve.
    
    Returns:
    info about this item containing only the specified fields.
  - updateInfo
```
public void updateInfo(BoxFolder.Info info)
```
    Updates the information about this folder with any info fields that have been modified locally.
    
    Parameters:
    info - the updated info.
  - copy
```
public BoxFolder.Info copy(BoxFolder destination)
```
    Description copied from class: BoxItem
    
    Copies this item to another folder.
    
    Specified by:
    
    copy in class BoxItem
    
    Parameters:
    destination - the destination folder.
    
    Returns:
    info about the copied item.
  - copy
```
public BoxFolder.Info copy(BoxFolder destination,
                  String newName)
```
    Description copied from class: BoxItem
    
    Copies this item to another folder and gives it a new name. If the destination is the same folder as the item's current parent, then newName must be a new, unique name.
    
    Specified by:
    
    copy in class BoxItem
    
    Parameters:
    destination - the destination folder.
    newName - a new name for the copied item.
    
    Returns:
    info about the copied item.
  - createFolder
```
public BoxFolder.Info createFolder(String name)
```
    Creates a new child folder inside this folder.
    
    Parameters:
    name - the new folder's name.
    
    Returns:
    the created folder's info.
  - delete
```
public void delete(boolean recursive)
```
    Deletes this folder, optionally recursively deleting all of its contents.
    
    Parameters:
    recursive - true to recursively delete this folder's contents; otherwise false.
  - move
```
public void move(BoxFolder destination)
```
    Moves this folder to another folder.
    
    Parameters:
    destination - the destination folder.
  - rename
```
public void rename(String newName)
```
    Renames this folder.
    
    Parameters:
    newName - the new name of the folder.
  - uploadFile
```
public BoxFile.Info uploadFile(InputStream fileContent,
                      String name)
```
    Uploads a new file to this folder.
    
    Parameters:
    fileContent - a stream containing the contents of the file to upload.
    name - the name to give the uploaded file.
    
    Returns:
    the uploaded file's info.
  - uploadFile
```
public BoxFile.Info uploadFile(InputStream fileContent,
                      String name,
                      long fileSize,
                      ProgressListener listener)
```
    Uploads a new file to this folder while reporting the progress to a ProgressListener.
    
    Parameters:
    fileContent - a stream containing the contents of the file to upload.
    name - the name to give the uploaded file.
    fileSize - the size of the file used for determining the progress of the upload.
    listener - a listener for monitoring the upload's progress.
    
    Returns:
    the uploaded file's info.
  - uploadFile
```
public BoxFile.Info uploadFile(FileUploadParams uploadParams)
```
    Uploads a new file to this folder with custom upload parameters.
    
    Parameters:
    uploadParams - the custom upload parameters.
    
    Returns:
    the uploaded file's info.
  - getChildren
```
public Iterable<BoxItem.Info> getChildren()
```
    Returns an iterable containing the items in this folder. Iterating over the iterable returned by this method is equivalent to iterating over this BoxFolder directly.
    
    Returns:
    an iterable containing the items in this folder.
  - getChildren
```
public Iterable<BoxItem.Info> getChildren(String... fields)
```
    Returns an iterable containing the items in this folder and specifies which child fields to retrieve from the API.
    
    Parameters:
    fields - the fields to retrieve.
    
    Returns:
    an iterable containing the items in this folder.
  - getChildrenRange
```
public PartialCollection<BoxItem.Info> getChildrenRange(long offset,
                                               long limit,
                                               String... fields)
```
    Retrieves a specific range of child items in this folder.
    
    Parameters:
    offset - the index of the first child item to retrieve.
    limit - the maximum number of children to retrieve after the offset.
    fields - the fields to retrieve.
    
    Returns:
    a partial collection containing the specified range of child items.
  - iterator
```
public Iterator<BoxItem.Info> iterator()
```
    Returns an iterator over the items in this folder.
    
    Specified by:
    
    iterator in interface Iterable<BoxItem.Info>
    
    Returns:
    an iterator over the items in this folder.
  - search
```
public Iterable<BoxItem.Info> search(String query)
```
    Searches this folder and all descendant folders using a given query.
    
    Parameters:
    query - the search query.
    
    Returns:
    an Iterable containing the search results.

Class BoxFolder

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class BoxResource

Methods inherited from class Object

Field Detail

ALL_FIELDS

Constructor Detail

BoxFolder

Method Detail

getRootFolder

collaborate

collaborate

createSharedLink

getCollaborations

getInfo

getInfo

updateInfo

copy

copy

createFolder

delete

move

rename

uploadFile

uploadFile

uploadFile

getChildren

getChildren

getChildrenRange

iterator

search