com.dropbox.core.v2.files

Class FolderSharingInfo.Builder

java.lang.Object

com.dropbox.core.v2.files.FolderSharingInfo.Builder

Enclosing class:

FolderSharingInfo

public static class FolderSharingInfo.Builder
extends Object

Builder for FolderSharingInfo.

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	noAccess
protected String	parentSharedFolderId
protected boolean	readOnly
protected String	sharedFolderId
protected boolean	traverseOnly

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Builder(boolean readOnly)

Method Summary

Modifier and Type	Method and Description
FolderSharingInfo	build() Builds an instance of FolderSharingInfo configured with this builder's values
FolderSharingInfo.Builder	withNoAccess(Boolean noAccess) Set value for optional field.
FolderSharingInfo.Builder	withParentSharedFolderId(String parentSharedFolderId) Set value for optional field.
FolderSharingInfo.Builder	withSharedFolderId(String sharedFolderId) Set value for optional field.
FolderSharingInfo.Builder	withTraverseOnly(Boolean traverseOnly) Set value for optional field.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

readOnly

protected final boolean readOnly

parentSharedFolderId

protected String parentSharedFolderId

sharedFolderId

protected String sharedFolderId

traverseOnly

protected boolean traverseOnly

noAccess

protected boolean noAccess

Constructor Detail

Builder

protected Builder(boolean readOnly)

Method Detail

withParentSharedFolderId

public FolderSharingInfo.Builder withParentSharedFolderId(String parentSharedFolderId)

Set value for optional field.

Parameters:

parentSharedFolderId - Set if the folder is contained by a shared folder. Must match pattern "[-_0-9a-zA-Z:]+".

Returns:

this builder

Throws:

IllegalArgumentException - If any argument does not meet its preconditions.

withSharedFolderId

public FolderSharingInfo.Builder withSharedFolderId(String sharedFolderId)

Set value for optional field.

Parameters:

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

Returns:

this builder

Throws:

IllegalArgumentException - If any argument does not meet its preconditions.

withTraverseOnly

public FolderSharingInfo.Builder withTraverseOnly(Boolean traverseOnly)

Set value for optional field.

If left unset or set to null, defaults to false.

Parameters:

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. Defaults to false when set to null.

Returns:

this builder

withNoAccess

public FolderSharingInfo.Builder withNoAccess(Boolean noAccess)

Set value for optional field.

If left unset or set to null, defaults to false.

Parameters:

noAccess - Specifies that the folder cannot be accessed by the user. Defaults to false when set to null.

Returns:

this builder

build

public FolderSharingInfo build()

Builds an instance of FolderSharingInfo configured with this builder's values

Returns:

new instance of FolderSharingInfo