Package com.dropbox.core.v2.files
Class SearchMatchV2
- java.lang.Object
-
- com.dropbox.core.v2.files.SearchMatchV2
-
public class SearchMatchV2 extends java.lang.Object
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
SearchMatchV2.Builder
Builder forSearchMatchV2
.
-
Field Summary
Fields Modifier and Type Field Description protected java.util.List<HighlightSpan>
highlightSpans
protected SearchMatchTypeV2
matchType
protected MetadataV2
metadata
-
Constructor Summary
Constructors Constructor Description SearchMatchV2(MetadataV2 metadata)
NoneSearchMatchV2(MetadataV2 metadata, SearchMatchTypeV2 matchType, java.util.List<HighlightSpan> highlightSpans)
UsenewBuilder(com.dropbox.core.v2.files.MetadataV2)
to create instances of this class without specifying values for all optional fields.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
equals(java.lang.Object obj)
java.util.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.java.lang.String
toString()
java.lang.String
toStringMultiline()
Returns a String representation of this object formatted for easier readability.
-
-
-
Field Detail
-
metadata
protected final MetadataV2 metadata
-
matchType
protected final SearchMatchTypeV2 matchType
-
highlightSpans
protected final java.util.List<HighlightSpan> highlightSpans
-
-
Constructor Detail
-
SearchMatchV2
public SearchMatchV2(MetadataV2 metadata, SearchMatchTypeV2 matchType, java.util.List<HighlightSpan> highlightSpans)
UsenewBuilder(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 benull
.matchType
- The type of the match.highlightSpans
- The list of HighlightSpan determines which parts of the file title should be highlighted. Must not contain anull
item.- Throws:
java.lang.IllegalArgumentException
- If any argument does not meet its preconditions.
-
SearchMatchV2
public SearchMatchV2(MetadataV2 metadata)
NoneThe default values for unset fields will be used.
- Parameters:
metadata
- The metadata for the matched file or folder. Must not benull
.- Throws:
java.lang.IllegalArgumentException
- If any argument does not meet its preconditions.
-
-
Method Detail
-
getMetadata
public MetadataV2 getMetadata()
The metadata for the matched file or folder.- Returns:
- value for this field, never
null
.
-
getMatchType
public SearchMatchTypeV2 getMatchType()
The type of the match.- Returns:
- value for this field, or
null
if not present.
-
getHighlightSpans
public java.util.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 benull
.- Returns:
- builder for this class.
- Throws:
java.lang.IllegalArgumentException
- If any argument does not meet its preconditions.
-
hashCode
public int hashCode()
- Overrides:
hashCode
in classjava.lang.Object
-
equals
public boolean equals(java.lang.Object obj)
- Overrides:
equals
in classjava.lang.Object
-
toString
public java.lang.String toString()
- Overrides:
toString
in classjava.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
-
-