Package com.dropbox.core.v2.files

Class SearchV2Result

java.lang.Object

com.dropbox.core.v2.files.SearchV2Result

public class SearchV2Result
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
protected final String	cursor
protected final boolean	hasMore
protected final List<SearchMatchV2>	matches

Constructor Summary

Constructors

Constructor	Description
SearchV2Result(List<SearchMatchV2> matches, boolean hasMore)	None
SearchV2Result(List<SearchMatchV2> matches, boolean hasMore, String cursor)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
String	getCursor()	Pass the cursor into DbxUserFilesRequests.searchContinueV2(String) to fetch the next page of results.
boolean	getHasMore()	Used for paging.
List<SearchMatchV2>	getMatches()	A list (possibly empty) of matches for the query.
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<SearchMatchV2> matches

hasMore

protected final boolean hasMore

cursor

@Nullable
protected final String cursor

Constructor Details

SearchV2Result

public SearchV2Result(@Nonnull
 List<SearchMatchV2> matches,
 boolean hasMore,
 @Nullable
 String cursor)

Parameters:

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

hasMore - Used for paging. If true, indicates there is another page of results available that can be fetched by calling DbxUserFilesRequests.searchContinueV2(String) with the cursor.

cursor - Pass the cursor into DbxUserFilesRequests.searchContinueV2(String) to fetch the next page of results. Must have length of at least 1.

Throws:

IllegalArgumentException - If any argument does not meet its preconditions.

SearchV2Result

public SearchV2Result(@Nonnull
 List<SearchMatchV2> matches,
 boolean hasMore)

None

The default values for unset fields will be used.

Parameters:

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

hasMore - Used for paging. If true, indicates there is another page of results available that can be fetched by calling DbxUserFilesRequests.searchContinueV2(String) with the cursor.

Throws:

IllegalArgumentException - If any argument does not meet its preconditions.

Method Details

getMatches

@Nonnull
public List<SearchMatchV2> getMatches()

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

Returns:

value for this field, never null.

getHasMore

public boolean getHasMore()

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

Returns:

value for this field.

getCursor

@Nullable
public String getCursor()

Pass the cursor into DbxUserFilesRequests.searchContinueV2(String) to fetch the next page of results.

Returns:

value for this field, or null if not present.

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