Package com.dropbox.core.v2.files

Class SearchOptions

java.lang.Object

com.dropbox.core.v2.files.SearchOptions

public class SearchOptions
extends java.lang.Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SearchOptions.Builder	Builder for SearchOptions.

Field Summary

Fields

Modifier and Type	Field	Description
protected java.util.List<FileCategory>	fileCategories
protected java.util.List<java.lang.String>	fileExtensions
protected boolean	filenameOnly
protected FileStatus	fileStatus
protected long	maxResults
protected SearchOrderBy	orderBy
protected java.lang.String	path

Constructor Summary

Constructors

Constructor	Description
SearchOptions()	None
SearchOptions(java.lang.String path, long maxResults, SearchOrderBy orderBy, FileStatus fileStatus, boolean filenameOnly, java.util.List<java.lang.String> fileExtensions, java.util.List<FileCategory> fileCategories)	Use newBuilder() to create instances of this class without specifying values for all optional fields.

Method Summary

Modifier and Type	Method	Description
boolean	equals(java.lang.Object obj)
java.util.List<FileCategory>	getFileCategories()	Restricts search to only the file categories specified.
java.util.List<java.lang.String>	getFileExtensions()	Restricts search to only the extensions specified.
boolean	getFilenameOnly()	Restricts search to only match on filenames.
FileStatus	getFileStatus()	Restricts search to the given file status.
long	getMaxResults()	The maximum number of search results to return.
SearchOrderBy	getOrderBy()	Specified property of the order of search results.
java.lang.String	getPath()	Scopes the search to a path in the user's Dropbox.
int	hashCode()
static SearchOptions.Builder	newBuilder()	Returns a new builder for creating an instance of this class.
java.lang.String	toString()
java.lang.String	toStringMultiline()	Returns a String representation of this object formatted for easier readability.

Methods inherited from class java.lang.Object

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

Field Detail

path

protected final java.lang.String path

maxResults

protected final long maxResults

orderBy

protected final SearchOrderBy orderBy

fileStatus

protected final FileStatus fileStatus

filenameOnly

protected final boolean filenameOnly

fileExtensions

protected final java.util.List<java.lang.String> fileExtensions

fileCategories

protected final java.util.List<FileCategory> fileCategories

Constructor Detail

SearchOptions

public SearchOptions(java.lang.String path,
                     long maxResults,
                     SearchOrderBy orderBy,
                     FileStatus fileStatus,
                     boolean filenameOnly,
                     java.util.List<java.lang.String> fileExtensions,
                     java.util.List<FileCategory> fileCategories)

Use newBuilder() to create instances of this class without specifying values for all optional fields.

Parameters:

path - Scopes the search to a path in the user's Dropbox. Searches the entire Dropbox if not specified. Must match pattern " (/(.|[\\r\\n])*)?|id:.*|(ns:[0-9]+(/.*)?)".

maxResults - The maximum number of search results to return. Must be greater than or equal to 1 and be less than or equal to 1000.

orderBy - Specified property of the order of search results. By default, results are sorted by relevance.

fileStatus - Restricts search to the given file status. Must not be null.

filenameOnly - Restricts search to only match on filenames.

fileExtensions - Restricts search to only the extensions specified. Only supported for active file search. Must not contain a null item.

fileCategories - Restricts search to only the file categories specified. Only supported for active file search. Must not contain a null item.

Throws:

java.lang.IllegalArgumentException - If any argument does not meet its preconditions.

SearchOptions

public SearchOptions()

None

The default values for unset fields will be used.

Method Detail

getPath

public java.lang.String getPath()

Scopes the search to a path in the user's Dropbox. Searches the entire Dropbox if not specified.

Returns:

value for this field, or null if not present.

getMaxResults

public long getMaxResults()

The maximum number of search results to return.

Returns:

value for this field, or null if not present. Defaults to 100L.

getOrderBy

public SearchOrderBy getOrderBy()

Specified property of the order of search results. By default, results are sorted by relevance.

Returns:

value for this field, or null if not present.

getFileStatus

public FileStatus getFileStatus()

Restricts search to the given file status.

Returns:

value for this field, or null if not present. Defaults to FileStatus.ACTIVE.

getFilenameOnly

public boolean getFilenameOnly()

Restricts search to only match on filenames.

Returns:

value for this field, or null if not present. Defaults to false.

getFileExtensions

public java.util.List<java.lang.String> getFileExtensions()

Restricts search to only the extensions specified. Only supported for active file search.

Returns:

value for this field, or null if not present.

getFileCategories

public java.util.List<FileCategory> getFileCategories()

Restricts search to only the file categories specified. Only supported for active file search.

Returns:

value for this field, or null if not present.

newBuilder

public static SearchOptions.Builder newBuilder()

Returns a new builder for creating an instance of this class.

Returns:

builder for this class.

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

toStringMultiline

public java.lang.String toStringMultiline()

Returns a String representation of this object formatted for easier readability.

The returned String may contain newlines.

Returns:

Formatted, multiline String representation of this object