Package com.dropbox.core.v2.files

Class FolderSharingInfo

  • public class FolderSharingInfo
extends SharingInfo
    Sharing info for a folder which is contained in a shared folder or is a shared folder mount point.

    • Constructor Summary

      Constructors 
      Constructor Description
      FolderSharingInfo​(boolean readOnly)
      Sharing info for a folder which is contained in a shared folder or is a shared folder mount point.
      FolderSharingInfo​(boolean readOnly, java.lang.String parentSharedFolderId, java.lang.String sharedFolderId, boolean traverseOnly, boolean noAccess)
      Sharing info for a folder which is contained in a shared folder or is a shared folder mount point.

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean equals​(java.lang.Object obj)  
      boolean getNoAccess()
      Specifies that the folder cannot be accessed by the user.
      java.lang.String getParentSharedFolderId()
      Set if the folder is contained by a shared folder.
      boolean getReadOnly()
      True if the file or folder is inside a read-only shared folder.
      java.lang.String getSharedFolderId()
      If this folder is a shared folder mount point, the ID of the shared folder mounted at this location.
      boolean getTraverseOnly()
      Specifies that the folder can only be traversed and the user can only see a limited subset of the contents of this folder because they don't have read access to this folder.
      int hashCode()  
      static FolderSharingInfo.Builder newBuilder​(boolean readOnly)
      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

      • parentSharedFolderId

        @Nullable
protected final java.lang.String parentSharedFolderId

      • sharedFolderId

        @Nullable
protected final java.lang.String sharedFolderId

      • traverseOnly

        protected final boolean traverseOnly

      • noAccess

        protected final boolean noAccess

    • Constructor Detail

      • FolderSharingInfo

        public FolderSharingInfo​(boolean readOnly,
                         @Nullable
                         java.lang.String parentSharedFolderId,
                         @Nullable
                         java.lang.String sharedFolderId,
                         boolean traverseOnly,
                         boolean noAccess)
        Sharing info for a folder which is contained in a shared folder or is a shared folder mount point.

        Use newBuilder(boolean) to create instances of this class without specifying values for all optional fields.

        Parameters:
        readOnly - True if the file or folder is inside a read-only shared folder.
        parentSharedFolderId - Set if the folder is contained by a shared folder. Must match pattern "[-_0-9a-zA-Z:]+".
        sharedFolderId - If this folder is a shared folder mount point, the ID of the shared folder mounted at this location. Must match pattern "[-_0-9a-zA-Z:]+".
        traverseOnly - Specifies that the folder can only be traversed and the user can only see a limited subset of the contents of this folder because they don't have read access to this folder. They do, however, have access to some sub folder.
        noAccess - Specifies that the folder cannot be accessed by the user.
        Throws:
        java.lang.IllegalArgumentException - If any argument does not meet its preconditions.

      • FolderSharingInfo

        public FolderSharingInfo​(boolean readOnly)
        Sharing info for a folder which is contained in a shared folder or is a shared folder mount point.

        The default values for unset fields will be used.

        Parameters:
        readOnly - True if the file or folder is inside a read-only shared folder.

    • Method Detail

      • getReadOnly

        public boolean getReadOnly()
        True if the file or folder is inside a read-only shared folder.
        Overrides:
        getReadOnly in class SharingInfo
        Returns:
        value for this field.

      • getParentSharedFolderId

        @Nullable
public java.lang.String getParentSharedFolderId()
        Set if the folder is contained by a shared folder.
        Returns:
        value for this field, or null if not present.

      • getSharedFolderId

        @Nullable
public java.lang.String getSharedFolderId()
        If this folder is a shared folder mount point, the ID of the shared folder mounted at this location.
        Returns:
        value for this field, or null if not present.

      • getTraverseOnly

        public boolean getTraverseOnly()
        Specifies that the folder can only be traversed and the user can only see a limited subset of the contents of this folder because they don't have read access to this folder. They do, however, have access to some sub folder.
        Returns:
        value for this field, or null if not present. Defaults to false.

      • getNoAccess

        public boolean getNoAccess()
        Specifies that the folder cannot be accessed by the user.
        Returns:
        value for this field, or null if not present. Defaults to false.

      • newBuilder

        public static FolderSharingInfo.Builder newBuilder​(boolean readOnly)
        Returns a new builder for creating an instance of this class.
        Parameters:
        readOnly - True if the file or folder is inside a read-only shared folder.
        Returns:
        builder for this class.

      • equals

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

      • 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 SharingInfo
        Returns:
        Formatted, multiline String representation of this object