com.dropbox.core.v2.sharing

Class FolderPolicy

java.lang.Object

com.dropbox.core.v2.sharing.FolderPolicy

public class FolderPolicy
extends Object

A set of policies governing membership and privileges for a shared folder.

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field and Description
protected AclUpdatePolicy	aclUpdatePolicy
protected MemberPolicy	memberPolicy
protected MemberPolicy	resolvedMemberPolicy
protected SharedLinkPolicy	sharedLinkPolicy

Constructor Summary

Constructors

Constructor and Description
FolderPolicy(AclUpdatePolicy aclUpdatePolicy, SharedLinkPolicy sharedLinkPolicy) A set of policies governing membership and privileges for a shared folder.
FolderPolicy(AclUpdatePolicy aclUpdatePolicy, SharedLinkPolicy sharedLinkPolicy, MemberPolicy memberPolicy, MemberPolicy resolvedMemberPolicy) A set of policies governing membership and privileges for a shared folder.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
AclUpdatePolicy	getAclUpdatePolicy() Who can add and remove members from this shared folder.
MemberPolicy	getMemberPolicy() Who can be a member of this shared folder, as set on the folder itself.
MemberPolicy	getResolvedMemberPolicy() Who can be a member of this shared folder, taking into account both the folder and the team-wide policy.
SharedLinkPolicy	getSharedLinkPolicy() Who links can be shared with.
int	hashCode()
static FolderPolicy.Builder	newBuilder(AclUpdatePolicy aclUpdatePolicy, SharedLinkPolicy sharedLinkPolicy) 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

memberPolicy

protected final MemberPolicy memberPolicy

resolvedMemberPolicy

protected final MemberPolicy resolvedMemberPolicy

aclUpdatePolicy

protected final AclUpdatePolicy aclUpdatePolicy

sharedLinkPolicy

protected final SharedLinkPolicy sharedLinkPolicy

Constructor Detail

FolderPolicy

public FolderPolicy(AclUpdatePolicy aclUpdatePolicy,
                    SharedLinkPolicy sharedLinkPolicy,
                    MemberPolicy memberPolicy,
                    MemberPolicy resolvedMemberPolicy)

A set of policies governing membership and privileges for a shared folder.

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

Parameters:

aclUpdatePolicy - Who can add and remove members from this shared folder. Must not be null.

sharedLinkPolicy - Who links can be shared with. Must not be null.

memberPolicy - Who can be a member of this shared folder, as set on the folder itself. The effective policy may differ from this value if the team-wide policy is more restrictive. Present only if the folder is owned by a team.

resolvedMemberPolicy - Who can be a member of this shared folder, taking into account both the folder and the team-wide policy. This value may differ from that of member_policy if the team-wide policy is more restrictive than the folder policy. Present only if the folder is owned by a team.

Throws:

IllegalArgumentException - If any argument does not meet its preconditions.

FolderPolicy

public FolderPolicy(AclUpdatePolicy aclUpdatePolicy,
                    SharedLinkPolicy sharedLinkPolicy)

A set of policies governing membership and privileges for a shared folder.

The default values for unset fields will be used.

Parameters:

aclUpdatePolicy - Who can add and remove members from this shared folder. Must not be null.

sharedLinkPolicy - Who links can be shared with. Must not be null.

Throws:

IllegalArgumentException - If any argument does not meet its preconditions.

Method Detail

getAclUpdatePolicy

public AclUpdatePolicy getAclUpdatePolicy()

Who can add and remove members from this shared folder.

Returns:

value for this field, never null.

getSharedLinkPolicy

public SharedLinkPolicy getSharedLinkPolicy()

Who links can be shared with.

Returns:

value for this field, never null.

getMemberPolicy

public MemberPolicy getMemberPolicy()

Who can be a member of this shared folder, as set on the folder itself. The effective policy may differ from this value if the team-wide policy is more restrictive. Present only if the folder is owned by a team.

Returns:

value for this field, or null if not present.

getResolvedMemberPolicy

public MemberPolicy getResolvedMemberPolicy()

Who can be a member of this shared folder, taking into account both the folder and the team-wide policy. This value may differ from that of member_policy if the team-wide policy is more restrictive than the folder policy. Present only if the folder is owned by a team.

Returns:

value for this field, or null if not present.

newBuilder

public static FolderPolicy.Builder newBuilder(AclUpdatePolicy aclUpdatePolicy,
                                              SharedLinkPolicy sharedLinkPolicy)

Returns a new builder for creating an instance of this class.

Parameters:

aclUpdatePolicy - Who can add and remove members from this shared folder. Must not be null.

sharedLinkPolicy - Who links can be shared with. 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