Package com.dropbox.core.v2.files

Class SearchMatchV2

java.lang.Object

com.dropbox.core.v2.files.SearchMatchV2

public class SearchMatchV2
extends Object

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field	Description
protected final List<HighlightSpan>	highlightSpans
protected final SearchMatchTypeV2	matchType
protected final MetadataV2	metadata

Constructor Summary

Constructors

Constructor	Description
SearchMatchV2(MetadataV2 metadata)	None
SearchMatchV2(MetadataV2 metadata, SearchMatchTypeV2 matchType, List<HighlightSpan> highlightSpans)	Use newBuilder(com.dropbox.core.v2.files.MetadataV2) to create instances of this class without specifying values for all optional fields.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
List<HighlightSpan>	getHighlightSpans()	The list of HighlightSpan determines which parts of the file title should be highlighted.
SearchMatchTypeV2	getMatchType()	The type of the match.
MetadataV2	getMetadata()	The metadata for the matched file or folder.
int	hashCode()
static SearchMatchV2.Builder	newBuilder(MetadataV2 metadata)	Returns a new builder for creating an instance of this class.
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

metadata

@Nonnull
protected final MetadataV2 metadata

matchType

@Nullable
protected final SearchMatchTypeV2 matchType

highlightSpans

@Nullable
protected final List<HighlightSpan> highlightSpans

Constructor Details

SearchMatchV2

public SearchMatchV2(@Nonnull
 MetadataV2 metadata,
 @Nullable
 SearchMatchTypeV2 matchType,
 @Nullable
 List<HighlightSpan> highlightSpans)

Use newBuilder(com.dropbox.core.v2.files.MetadataV2) to create instances of this class without specifying values for all optional fields.

Parameters:

metadata - The metadata for the matched file or folder. Must not be null.

matchType - The type of the match.

highlightSpans - The list of HighlightSpan determines which parts of the file title should be highlighted. Must not contain a null item.

Throws:

IllegalArgumentException - If any argument does not meet its preconditions.

SearchMatchV2

public SearchMatchV2(@Nonnull
 MetadataV2 metadata)

None

The default values for unset fields will be used.

Parameters:

metadata - The metadata for the matched file or folder. Must not be null.

Throws:

IllegalArgumentException - If any argument does not meet its preconditions.

Method Details

getMetadata

@Nonnull
public MetadataV2 getMetadata()

The metadata for the matched file or folder.

Returns:

value for this field, never null.

getMatchType

@Nullable
public SearchMatchTypeV2 getMatchType()

The type of the match.

Returns:

value for this field, or null if not present.

getHighlightSpans

@Nullable
public List<HighlightSpan> getHighlightSpans()

The list of HighlightSpan determines which parts of the file title should be highlighted.

Returns:

value for this field, or null if not present.

newBuilder

public static SearchMatchV2.Builder newBuilder(MetadataV2 metadata)

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

Parameters:

metadata - The metadata for the matched file or folder. Must not be null.

Returns:

builder for this class.

Throws:

IllegalArgumentException - If any argument does not meet its preconditions.

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