Package com.dropbox.core.v2.sharing

Class SharedFolderMetadataBase

java.lang.Object

com.dropbox.core.v2.sharing.SharedFolderMetadataBase

Direct Known Subclasses:

SharedFolderMetadata

public class SharedFolderMetadataBase
extends java.lang.Object

Properties of the shared folder.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SharedFolderMetadataBase.Builder	Builder for SharedFolderMetadataBase.

Field Summary

Fields

Modifier and Type	Field	Description
protected AccessLevel	accessType
protected boolean	isInsideTeamFolder
protected boolean	isTeamFolder
protected java.util.List<java.lang.String>	ownerDisplayNames
protected Team	ownerTeam
protected java.lang.String	parentFolderName
protected java.lang.String	parentSharedFolderId
protected java.lang.String	pathLower

Constructor Summary

Constructors

Constructor	Description
SharedFolderMetadataBase(AccessLevel accessType, boolean isInsideTeamFolder, boolean isTeamFolder)	Properties of the shared folder.
SharedFolderMetadataBase(AccessLevel accessType, boolean isInsideTeamFolder, boolean isTeamFolder, java.util.List<java.lang.String> ownerDisplayNames, Team ownerTeam, java.lang.String parentSharedFolderId, java.lang.String pathLower, java.lang.String parentFolderName)	Properties of the shared folder.

Method Summary

Modifier and Type	Method	Description
boolean	equals(java.lang.Object obj)
AccessLevel	getAccessType()	The current user's access level for this shared folder.
boolean	getIsInsideTeamFolder()	Whether this folder is inside of a team folder.
boolean	getIsTeamFolder()	Whether this folder is a team folder.
java.util.List<java.lang.String>	getOwnerDisplayNames()	The display names of the users that own the folder.
Team	getOwnerTeam()	The team that owns the folder.
java.lang.String	getParentFolderName()	Display name for the parent folder.
java.lang.String	getParentSharedFolderId()	The ID of the parent shared folder.
java.lang.String	getPathLower()	The lower-cased full path of this shared folder.
int	hashCode()
static SharedFolderMetadataBase.Builder	newBuilder(AccessLevel accessType, boolean isInsideTeamFolder, boolean isTeamFolder)	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

accessType

protected final AccessLevel accessType

isInsideTeamFolder

protected final boolean isInsideTeamFolder

isTeamFolder

protected final boolean isTeamFolder

ownerDisplayNames

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

ownerTeam

protected final Team ownerTeam

parentSharedFolderId

protected final java.lang.String parentSharedFolderId

pathLower

protected final java.lang.String pathLower

parentFolderName

protected final java.lang.String parentFolderName

Constructor Detail

SharedFolderMetadataBase

public SharedFolderMetadataBase(AccessLevel accessType,
                                boolean isInsideTeamFolder,
                                boolean isTeamFolder,
                                java.util.List<java.lang.String> ownerDisplayNames,
                                Team ownerTeam,
                                java.lang.String parentSharedFolderId,
                                java.lang.String pathLower,
                                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:]+".

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(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

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

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

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

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.

getPathLower

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

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