Package com.dropbox.core.v2.sharing

Class PathLinkMetadata

  • public class PathLinkMetadata
extends LinkMetadata
    Metadata for a path-based shared link.

    • Field Summary

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

    • Constructor Summary

      Constructors 
      Constructor Description
      PathLinkMetadata​(java.lang.String url, Visibility visibility, java.lang.String path)
      Metadata for a path-based shared link.
      PathLinkMetadata​(java.lang.String url, Visibility visibility, java.lang.String path, java.util.Date expires)
      Metadata for a path-based shared link.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean equals​(java.lang.Object obj)  
      java.util.Date getExpires()
      Expiration time, if set.
      java.lang.String getPath()
      Path in user's Dropbox.
      java.lang.String getUrl()
      URL of the shared link.
      Visibility getVisibility()
      Who can access the link.
      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

    • Constructor Detail

      • PathLinkMetadata

        public PathLinkMetadata​(@Nonnull
                        java.lang.String url,
                        @Nonnull
                        Visibility visibility,
                        @Nonnull
                        java.lang.String path,
                        @Nullable
                        java.util.Date expires)
        Metadata for a path-based shared link.
        Parameters:
        url - URL of the shared link. Must not be null.
        visibility - Who can access the link. Must not be null.
        path - Path in user's Dropbox. Must not be null.
        expires - Expiration time, if set. By default the link won't expire.
        Throws:
        java.lang.IllegalArgumentException - If any argument does not meet its preconditions.

      • PathLinkMetadata

        public PathLinkMetadata​(@Nonnull
                        java.lang.String url,
                        @Nonnull
                        Visibility visibility,
                        @Nonnull
                        java.lang.String path)
        Metadata for a path-based shared link.

        The default values for unset fields will be used.

        Parameters:
        url - URL of the shared link. Must not be null.
        visibility - Who can access the link. Must not be null.
        path - Path in user's Dropbox. 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()
        URL of the shared link.
        Overrides:
        getUrl in class LinkMetadata
        Returns:
        value for this field, never null.

      • getVisibility

        @Nonnull
public Visibility getVisibility()
        Who can access the link.
        Overrides:
        getVisibility in class LinkMetadata
        Returns:
        value for this field, never null.

      • getPath

        @Nonnull
public java.lang.String getPath()
        Path in user's Dropbox.
        Returns:
        value for this field, never null.

      • getExpires

        @Nullable
public java.util.Date getExpires()
        Expiration time, if set. By default the link won't expire.
        Overrides:
        getExpires in class LinkMetadata
        Returns:
        value for this field, or null if not present.

      • equals

        public boolean equals​(java.lang.Object obj)
        Overrides:
        equals in class LinkMetadata

      • toStringMultiline

        public java.lang.String toStringMultiline()
        Returns a String representation of this object formatted for easier readability.

        The returned String may contain newlines.

        Overrides:
        toStringMultiline in class LinkMetadata
        Returns:
        Formatted, multiline String representation of this object