Package com.dropbox.core.v2.files

Class SharedLinkFileInfo

  • public class SharedLinkFileInfo
extends java.lang.Object

    • Field Summary

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

    • Constructor Summary

      Constructors 
      Constructor Description
      SharedLinkFileInfo​(java.lang.String url)
      None
      SharedLinkFileInfo​(java.lang.String url, java.lang.String path, java.lang.String password)
      Use newBuilder(java.lang.String) 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.lang.String getPassword()
      Password for the shared link.
      java.lang.String getPath()
      The path corresponding to a file in a shared link to a folder.
      java.lang.String getUrl()
      The shared link corresponding to either a file or shared link to a folder.
      int hashCode()  
      static SharedLinkFileInfo.Builder newBuilder​(java.lang.String url)
      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.

      • Methods inherited from class java.lang.Object

        clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    • Field Detail

      • url

        @Nonnull
protected final java.lang.String url

      • path

        @Nullable
protected final java.lang.String path

      • password

        @Nullable
protected final java.lang.String password

    • Constructor Detail

      • SharedLinkFileInfo

        public SharedLinkFileInfo​(@Nonnull
                          java.lang.String url,
                          @Nullable
                          java.lang.String path,
                          @Nullable
                          java.lang.String password)
        Use newBuilder(java.lang.String) to create instances of this class without specifying values for all optional fields.
        Parameters:
        url - The shared link corresponding to either a file or shared link to a folder. If it is for a folder shared link, we use the path param to determine for which file in the folder the view is for. Must not be null.
        path - The path corresponding to a file in a shared link to a folder. Required for shared links to folders.
        password - Password for the shared link. Required for password-protected shared links to files unless it can be read from a cookie.
        Throws:
        java.lang.IllegalArgumentException - If any argument does not meet its preconditions.

      • SharedLinkFileInfo

        public SharedLinkFileInfo​(@Nonnull
                          java.lang.String url)
        None

        The default values for unset fields will be used.

        Parameters:
        url - The shared link corresponding to either a file or shared link to a folder. If it is for a folder shared link, we use the path param to determine for which file in the folder the view is for. Must not be null.
        Throws:
        java.lang.IllegalArgumentException - If any argument does not meet its preconditions.

    • Method Detail

      • getUrl

        @Nonnull
public java.lang.String getUrl()
        The shared link corresponding to either a file or shared link to a folder. If it is for a folder shared link, we use the path param to determine for which file in the folder the view is for.
        Returns:
        value for this field, never null.

      • getPath

        @Nullable
public java.lang.String getPath()
        The path corresponding to a file in a shared link to a folder. Required for shared links to folders.
        Returns:
        value for this field, or null if not present.

      • getPassword

        @Nullable
public java.lang.String getPassword()
        Password for the shared link. Required for password-protected shared links to files unless it can be read from a cookie.
        Returns:
        value for this field, or null if not present.

      • newBuilder

        public static SharedLinkFileInfo.Builder newBuilder​(java.lang.String url)
        Returns a new builder for creating an instance of this class.
        Parameters:
        url - The shared link corresponding to either a file or shared link to a folder. If it is for a folder shared link, we use the path param to determine for which file in the folder the view is for. 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