Package com.amilesend.onedrive.resource

Class DriveItemFolderType

java.lang.Object

com.amilesend.onedrive.resource.DriveItemType

com.amilesend.onedrive.resource.DriveItemFolderType

Direct Known Subclasses:

DriveFolder, DrivePackage

public abstract class DriveItemFolderType
extends DriveItemType

Defines shared operations between drive folders and packages.

See Also:

• DriveFolder
• DrivePackage

Constructor Summary

Constructors

Constructor	Description
DriveItemFolderType(DriveItem delegate)	Creates a new DriveItemFolderType that wraps the given delegate DriveItem.

Method Summary

Modifier and Type	Method	Description
DriveFolder	createFolder(String name)	Creates a new folder with the given name under this folder.
List<DriveFile>	getChildFiles()	Gets the list of child drive files under this folder.
List<DriveFolder>	getChildFolders()	Gets the list of child drive folders under this folder.
List<DrivePackage>	getChildPackages()	Gets the list of child drive packages under this folder.
List<? extends DriveItemType>	getChildren()	Gets the list of drive items (both folders and files) under this folder.
DriveFolder	move(@NonNull DriveFolder destinationFolder, String newName)	Moves this folder to the specified DriveFolder along with the new file name.
DriveFolder	move(DriveFolder destinationFolder)	Moves this folder to the specified DriveFolder.
DriveFolder	move(String destinationParentId, String newName)	Moves this folder to the specified newParentId (i.e., represents a new DriveFolder's ID) along with the new folder name.
List<? extends DriveItemType>	search(String query)	Searches this folder for the given query (e.g., file name).
DriveFolder	update()	Updates the attributes for this folder.
DriveFile	upload(File file)	Uploads the given file under this folder.
DriveFile	upload(File file, TransferProgressCallback callback)	Uploads the given file under this folder and reports transfer progress to the specified TransferProgressCallback.
DriveFileUploadExecution	uploadAsync(File file)	Uploads the given file asynchronously under this folder.
DriveFileUploadExecution	uploadAsync(File file, TransferProgressCallback callback)	Uploads the given file asynchronously under this folder and reports transfer progress to the specified TransferProgressCallback.

Methods inherited from class com.amilesend.onedrive.resource.DriveItemType

addPermission, copy, copy, copy, copy, createSharingLink, delete, equals, getActivities, getCreatedBy, getCreatedDateTime, getETag, getFileSystemInfo, getId, getLastModifiedBy, getLastModifiedDateTime, getName, getPackage, getParentReference, getPermissions, getRemoteItem, getThumbnails, getVersions, hashCode, isDeleted, isFile, isFolder, isPackage, isRemote, setFileSystemInfo

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Details

DriveItemFolderType

public DriveItemFolderType(DriveItem delegate)

Creates a new DriveItemFolderType that wraps the given delegate DriveItem.

Parameters:

delegate - the drive item to wrap

Method Details

upload

public DriveFile upload(File file)
                 throws IOException

Uploads the given file under this folder.

Parameters:

file - the file to upload

Returns:

the drive file that represents the uploaded file

Throws:

IOException - if an error occurred while uploading the file

See Also:

• DriveFile

upload

public DriveFile upload(File file,
 TransferProgressCallback callback)
                 throws IOException

Uploads the given file under this folder and reports transfer progress to the specified TransferProgressCallback.

Parameters:

file - the file to upload

callback - the callback be notified of transfer progress

Returns:

the drive file that represents the uploaded file

Throws:

IOException - if an error occurred while uploading the file

See Also:

• DriveFile

uploadAsync

public DriveFileUploadExecution uploadAsync(File file)
                                     throws IOException

Uploads the given file asynchronously under this folder.

Parameters:

file - the file to upload

Returns:

the async execution used to obtain the drive file once it has completed

Throws:

IOException - if an error occurred while uploading the file

See Also:

• DriveFileUploadExecution

uploadAsync

public DriveFileUploadExecution uploadAsync(File file,
 TransferProgressCallback callback)
                                     throws IOException

Uploads the given file asynchronously under this folder and reports transfer progress to the specified TransferProgressCallback.

Parameters:

file - the file to upload

callback - the callback be notified of transfer progress

Returns:

the async execution used to obtain the drive file once it has completed

Throws:

IOException - if an error occurred while uploading the file

See Also:

• DriveFileUploadExecution

createFolder

public DriveFolder createFolder(String name)

Creates a new folder with the given name under this folder.

Parameters:

name - the name of the new folder

Returns:

the new drive folder

getChildPackages

public List<DrivePackage> getChildPackages()

Gets the list of child drive packages under this folder.

Returns:

the list of drive packages

getChildFolders

public List<DriveFolder> getChildFolders()

Gets the list of child drive folders under this folder.

Returns:

the list of drive folders

getChildFiles

public List<DriveFile> getChildFiles()

Gets the list of child drive files under this folder.

Returns:

the list of drive files

getChildren

public List<? extends DriveItemType> getChildren()

Gets the list of drive items (both folders and files) under this folder.

Returns:

the list of drive items

See Also:

• DriveItemType
• DriveItem

search

public List<? extends DriveItemType> search(String query)

Searches this folder for the given query (e.g., file name).

Parameters:

query - the search query

Returns:

the list of drive item types (either a DriveFolder or DriveFile).

See Also:

• DriveItemType
• DriveFile

update

public DriveFolder update()

Updates the attributes for this folder.

Returns:

the updated drive folder

move

public DriveFolder move(DriveFolder destinationFolder)

Moves this folder to the specified DriveFolder.

Parameters:

destinationFolder - the destination drive folder

Returns:

the updated drive file that represents this moved file

move

public DriveFolder move(@NonNull DriveFolder destinationFolder,
 String newName)

Moves this folder to the specified DriveFolder along with the new file name.

Parameters:

destinationFolder - the destination drive folder

newName - the new name of the file

Returns:

the updated drive folder that represents this moved folder

move

public DriveFolder move(String destinationParentId,
 String newName)

Moves this folder to the specified newParentId (i.e., represents a new DriveFolder's ID) along with the new folder name.

Parameters:

destinationParentId - the new parent destination ID

newName - the new name of the file

Returns:

the updated drive folder that represents this moved folder