Class SearchMatchV2


  • public class SearchMatchV2
    extends java.lang.Object
    • Field Detail

      • metadata

        @Nonnull
        protected final MetadataV2 metadata
      • highlightSpans

        @Nullable
        protected final java.util.List<HighlightSpan> highlightSpans
    • Constructor Detail

      • SearchMatchV2

        public SearchMatchV2​(@Nonnull
                             MetadataV2 metadata,
                             @Nullable
                             SearchMatchTypeV2 matchType,
                             @Nullable
                             java.util.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:
        java.lang.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:
        java.lang.IllegalArgumentException - If any argument does not meet its preconditions.
    • Method Detail

      • 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 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 be null.
        Returns:
        builder for this class.
        Throws:
        java.lang.IllegalArgumentException - If any argument does not meet its preconditions.
      • 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