Package com.dropbox.core.v2.files

Class ExportArg

  • public class ExportArg
extends java.lang.Object

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  ExportArg.Serializer
      For internal use only.

    • Field Summary

      Fields 
      Modifier and Type Field Description
      protected java.lang.String exportFormat  
      protected java.lang.String path  

    • Constructor Summary

      Constructors 
      Constructor Description
      ExportArg​(java.lang.String path)
      None
      ExportArg​(java.lang.String path, java.lang.String exportFormat)  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean equals​(java.lang.Object obj)  
      java.lang.String getExportFormat()
      The file format to which the file should be exported.
      java.lang.String getPath()
      The path of the file to be exported.
      int hashCode()  
      java.lang.String toString()  
      java.lang.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 Detail

      • path

        @Nonnull
protected final java.lang.String path

      • exportFormat

        @Nullable
protected final java.lang.String exportFormat

    • Constructor Detail

      • ExportArg

        public ExportArg​(@Nonnull
                 java.lang.String path,
                 @Nullable
                 java.lang.String exportFormat)
        Parameters:
        path - The path of the file to be exported. Must match pattern "(/(.|[\\r\\n])*|id:.*)|(rev:[0-9a-f]{9,})|(ns:[0-9]+(/.*)?)" and not be null.
        exportFormat - The file format to which the file should be exported. This must be one of the formats listed in the file's export_options returned by DbxUserFilesRequests.getMetadata(String). If none is specified, the default format (specified in export_as in file metadata) will be used.
        Throws:
        java.lang.IllegalArgumentException - If any argument does not meet its preconditions.

      • ExportArg

        public ExportArg​(@Nonnull
                 java.lang.String path)
        None

        The default values for unset fields will be used.

        Parameters:
        path - The path of the file to be exported. Must match pattern "(/(.|[\\r\\n])*|id:.*)|(rev:[0-9a-f]{9,})|(ns:[0-9]+(/.*)?)" and not be null.
        Throws:
        java.lang.IllegalArgumentException - If any argument does not meet its preconditions.

    • Method Detail

      • getPath

        @Nonnull
public java.lang.String getPath()
        The path of the file to be exported.
        Returns:
        value for this field, never null.

      • getExportFormat

        @Nullable
public java.lang.String getExportFormat()
        The file format to which the file should be exported. This must be one of the formats listed in the file's export_options returned by DbxUserFilesRequests.getMetadata(String). If none is specified, the default format (specified in export_as in file metadata) will be used.
        Returns:
        value for this field, or null if not present.

      • 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