com.dropbox.core.v2.sharing

Class SharedFolderMetadataBase

java.lang.Object

com.dropbox.core.v2.sharing.SharedFolderMetadataBase

Direct Known Subclasses:

SharedFolderMetadata

public class SharedFolderMetadataBase
extends Object

Properties of the shared folder.

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field and Description
protected AccessLevel	accessType
protected boolean	isTeamFolder
protected Team	ownerTeam
protected String	parentSharedFolderId
protected FolderPolicy	policy

Constructor Summary

Constructors

Constructor and Description
SharedFolderMetadataBase(AccessLevel accessType, boolean isTeamFolder, FolderPolicy policy) Properties of the shared folder.
SharedFolderMetadataBase(AccessLevel accessType, boolean isTeamFolder, FolderPolicy policy, Team ownerTeam, String parentSharedFolderId) Properties of the shared folder.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
AccessLevel	getAccessType() The current user's access level for this shared folder.
boolean	getIsTeamFolder() Whether this folder is a team folder.
Team	getOwnerTeam() The team that owns the folder.
String	getParentSharedFolderId() The ID of the parent shared folder.
FolderPolicy	getPolicy() Policies governing this shared folder.
int	hashCode()
static SharedFolderMetadataBase.Builder	newBuilder(AccessLevel accessType, boolean isTeamFolder, FolderPolicy policy) Returns a new builder for creating an instance of this class.
String	toString()
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

isTeamFolder

protected final boolean isTeamFolder

policy

protected final FolderPolicy policy

ownerTeam

protected final Team ownerTeam

parentSharedFolderId

protected final String parentSharedFolderId

Constructor Detail

SharedFolderMetadataBase

public SharedFolderMetadataBase(AccessLevel accessType,
                                boolean isTeamFolder,
                                FolderPolicy policy,
                                Team ownerTeam,
                                String parentSharedFolderId)

Properties of the shared folder.

Use newBuilder 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.

isTeamFolder - Whether this folder is a team folder.

policy - Policies governing this shared folder. Must not be null.

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:]+".

Throws:

IllegalArgumentException - If any argument does not meet its preconditions.

SharedFolderMetadataBase

public SharedFolderMetadataBase(AccessLevel accessType,
                                boolean isTeamFolder,
                                FolderPolicy policy)

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.

isTeamFolder - Whether this folder is a team folder.

policy - Policies governing this shared folder. Must not be null.

Throws:

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.

getIsTeamFolder

public boolean getIsTeamFolder()

Whether this folder is a team folder.

Returns:

value for this field.

getPolicy

public FolderPolicy getPolicy()

Policies governing this shared folder.

Returns:

value for this field, never null.

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

newBuilder

public static SharedFolderMetadataBase.Builder newBuilder(AccessLevel accessType,
                                                          boolean isTeamFolder,
                                                          FolderPolicy policy)

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.

isTeamFolder - Whether this folder is a team folder.

policy - Policies governing this shared folder. Must not be null.

Returns:

builder for this class.

Throws:

IllegalArgumentException - If any argument does not meet its preconditions.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

toStringMultiline

public 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