Package com.dropbox.core.v2.files

Class MetadataV2

java.lang.Object
com.dropbox.core.v2.files.MetadataV2
public final class MetadataV2 extends Object
Metadata for a file, folder or other resource types.

This class is an open tagged union. Tagged unions instances are always associated to a specific tag. This means only one of the isAbc() methods will return true. You can use tag() to determine the tag associated with this instance.

Open unions may be extended in the future with additional tags. If a new tag is introduced that this SDK does not recognized, the OTHER value will be used.

  • Field Details

    • OTHER

      public static final MetadataV2 OTHER
      Catch-all used for unknown tag values returned by the Dropbox servers.

      Receiving a catch-all value typically indicates this SDK version is not up to date. Consider updating your SDK version to handle the new tags.

  • Method Details

    • tag

      public MetadataV2.Tag tag()
      Returns the tag for this instance.

      This class is a tagged union. Tagged unions instances are always associated to a specific tag. This means only one of the isXyz() methods will return true. Callers are recommended to use the tag value in a switch statement to properly handle the different values for this MetadataV2.

      If a tag returned by the server is unrecognized by this SDK, the MetadataV2.Tag.OTHER value will be used.

      Returns:
      the tag for this instance.

    • isMetadata

      public boolean isMetadata()
      Returns true if this instance has the tag MetadataV2.Tag.METADATA, false otherwise.
      Returns:
      true if this instance is tagged as MetadataV2.Tag.METADATA, false otherwise.

    • metadata

      public static MetadataV2 metadata(Metadata value)
      Returns an instance of MetadataV2 that has its tag set to MetadataV2.Tag.METADATA.

      None

      Parameters:
      value - value to assign to this instance.
      Returns:
      Instance of MetadataV2 with its tag set to MetadataV2.Tag.METADATA.
      Throws:
      IllegalArgumentException - if value is null.

    • getMetadataValue

      public Metadata getMetadataValue()
      This instance must be tagged as MetadataV2.Tag.METADATA.
      Returns:
      The Metadata value associated with this instance if isMetadata() is true.
      Throws:
      IllegalStateException - If isMetadata() is false.

    • isOther

      public boolean isOther()
      Returns true if this instance has the tag MetadataV2.Tag.OTHER, false otherwise.
      Returns:
      true if this instance is tagged as MetadataV2.Tag.OTHER, false otherwise.

    • 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