Package com.dropbox.core.v2.files

Class SearchResult

java.lang.Object

com.dropbox.core.v2.files.SearchResult

public class SearchResult
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
protected final List<SearchMatch>	matches
protected final boolean	more
protected final long	start

Constructor Summary

Constructors

Constructor	Description
SearchResult(List<SearchMatch> matches, boolean more, long start)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
List<SearchMatch>	getMatches()	A list (possibly empty) of matches for the query.
boolean	getMore()	Used for paging.
long	getStart()	Used for paging.
int	hashCode()
String	toString()
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 Details

matches

@Nonnull
protected final List<SearchMatch> matches

more

protected final boolean more

start

protected final long start

Constructor Details

SearchResult

public SearchResult(@Nonnull
 List<SearchMatch> matches,
 boolean more,
 long start)

Parameters:

matches - A list (possibly empty) of matches for the query. Must not contain a null item and not be null.

more - Used for paging. If true, indicates there is another page of results available that can be fetched by calling DbxUserFilesRequests.search(String,String) again.

start - Used for paging. Value to set the start argument to when calling DbxUserFilesRequests.search(String,String) to fetch the next page of results.

Throws:

IllegalArgumentException - If any argument does not meet its preconditions.

Method Details

getMatches

@Nonnull
public List<SearchMatch> getMatches()

A list (possibly empty) of matches for the query.

Returns:

value for this field, never null.

getMore

public boolean getMore()

Used for paging. If true, indicates there is another page of results available that can be fetched by calling DbxUserFilesRequests.search(String,String) again.

Returns:

value for this field.

getStart

public long getStart()

Used for paging. Value to set the start argument to when calling DbxUserFilesRequests.search(String,String) to fetch the next page of results.

Returns:

value for this field.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

toStringMultiline

public 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