Package com.dropbox.core.v2.sharing

Class SharedFolderMetadataBase

  • Direct Known Subclasses:
    SharedFolderMetadata
    public class SharedFolderMetadataBase
extends java.lang.Object
    Properties of the shared folder.

    • Field Detail

      • accessType

        @Nonnull
protected final AccessLevel accessType

      • isInsideTeamFolder

        protected final boolean isInsideTeamFolder

      • isTeamFolder

        protected final boolean isTeamFolder

      • ownerDisplayNames

        @Nullable
protected final java.util.List<java.lang.String> ownerDisplayNames

      • ownerTeam

        @Nullable
protected final Team ownerTeam

      • parentSharedFolderId

        @Nullable
protected final java.lang.String parentSharedFolderId

      • pathDisplay

        @Nullable
protected final java.lang.String pathDisplay

      • pathLower

        @Nullable
protected final java.lang.String pathLower

      • parentFolderName

        @Nullable
protected final java.lang.String parentFolderName

    • Constructor Detail

      • SharedFolderMetadataBase

        public SharedFolderMetadataBase​(@Nonnull
                                AccessLevel accessType,
                                boolean isInsideTeamFolder,
                                boolean isTeamFolder,
                                @Nullable
                                java.util.List<java.lang.String> ownerDisplayNames,
                                @Nullable
                                Team ownerTeam,
                                @Nullable
                                java.lang.String parentSharedFolderId,
                                @Nullable
                                java.lang.String pathDisplay,
                                @Nullable
                                java.lang.String pathLower,
                                @Nullable
                                java.lang.String parentFolderName)
        Properties of the shared folder.

        Use newBuilder(com.dropbox.core.v2.sharing.AccessLevel,boolean,boolean) to create instances of this class without specifying values for all optional fields.

        Parameters:
        accessType - The current user's access level for this shared folder. Must not be null.
        isInsideTeamFolder - Whether this folder is inside of a team folder.
        isTeamFolder - Whether this folder is a team folder.
        ownerDisplayNames - The display names of the users that own the folder. If the folder is part of a team folder, the display names of the team admins are also included. Absent if the owner display names cannot be fetched. Must not contain a null item.
        ownerTeam - The team that owns the folder. This field is not present if the folder is not owned by a team.
        parentSharedFolderId - The ID of the parent shared folder. This field is present only if the folder is contained within another shared folder. Must match pattern "[-_0-9a-zA-Z:]+".
        pathDisplay - The full path of this shared folder. Absent for unmounted folders.
        pathLower - The lower-cased full path of this shared folder. Absent for unmounted folders.
        parentFolderName - Display name for the parent folder.
        Throws:
        java.lang.IllegalArgumentException - If any argument does not meet its preconditions.

      • SharedFolderMetadataBase

        public SharedFolderMetadataBase​(@Nonnull
                                AccessLevel accessType,
                                boolean isInsideTeamFolder,
                                boolean isTeamFolder)
        Properties of the shared folder.

        The default values for unset fields will be used.

        Parameters:
        accessType - The current user's access level for this shared folder. Must not be null.
        isInsideTeamFolder - Whether this folder is inside of a team folder.
        isTeamFolder - Whether this folder is a team folder.
        Throws:
        java.lang.IllegalArgumentException - If any argument does not meet its preconditions.

    • Method Detail

      • getAccessType

        @Nonnull
public AccessLevel getAccessType()
        The current user's access level for this shared folder.
        Returns:
        value for this field, never null.

      • getIsInsideTeamFolder

        public boolean getIsInsideTeamFolder()
        Whether this folder is inside of a team folder.
        Returns:
        value for this field.

      • getIsTeamFolder

        public boolean getIsTeamFolder()
        Whether this folder is a team folder.
        Returns:
        value for this field.

      • getOwnerDisplayNames

        @Nullable
public java.util.List<java.lang.String> getOwnerDisplayNames()
        The display names of the users that own the folder. If the folder is part of a team folder, the display names of the team admins are also included. Absent if the owner display names cannot be fetched.
        Returns:
        value for this field, or null if not present.

      • getOwnerTeam

        @Nullable
public Team getOwnerTeam()
        The team that owns the folder. This field is not present if the folder is not owned by a team.
        Returns:
        value for this field, or null if not present.

      • getParentSharedFolderId

        @Nullable
public java.lang.String getParentSharedFolderId()
        The ID of the parent shared folder. This field is present only if the folder is contained within another shared folder.
        Returns:
        value for this field, or null if not present.

      • getPathDisplay

        @Nullable
public java.lang.String getPathDisplay()
        The full path of this shared folder. Absent for unmounted folders.
        Returns:
        value for this field, or null if not present.

      • getPathLower

        @Nullable
public java.lang.String getPathLower()
        The lower-cased full path of this shared folder. Absent for unmounted folders.
        Returns:
        value for this field, or null if not present.

      • getParentFolderName

        @Nullable
public java.lang.String getParentFolderName()
        Display name for the parent folder.
        Returns:
        value for this field, or null if not present.

      • newBuilder

        public static SharedFolderMetadataBase.Builder newBuilder​(AccessLevel accessType,
                                                          boolean isInsideTeamFolder,
                                                          boolean isTeamFolder)
        Returns a new builder for creating an instance of this class.
        Parameters:
        accessType - The current user's access level for this shared folder. Must not be null.
        isInsideTeamFolder - Whether this folder is inside of a team folder.
        isTeamFolder - Whether this folder is a team folder.
        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