Package com.dropbox.core.v2.sharing

Class SharePathError

java.lang.Object

com.dropbox.core.v2.sharing.SharePathError

public final class SharePathError
extends Object

This class is an open tagged union. Tagged unions instances are always associated to a specific tag. This means only one of the isAbc() methods will return true. You can use tag() to determine the tag associated with this instance.

Open unions may be extended in the future with additional tags. If a new tag is introduced that this SDK does not recognized, the OTHER value will be used.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	SharePathError.Tag	Discriminating tag type for SharePathError.

Field Summary

Fields

Modifier and Type	Field	Description
static final SharePathError	CONTAINS_APP_FOLDER	We do not support shared folders that contain app folders.
static final SharePathError	CONTAINS_SHARED_FOLDER	We do not support shared folders that contain shared folders.
static final SharePathError	CONTAINS_TEAM_FOLDER	We do not support shared folders that contain team folders.
static final SharePathError	INSIDE_APP_FOLDER	We do not support sharing a folder inside an app folder.
static final SharePathError	INSIDE_OSX_PACKAGE	We do not support sharing a folder inside a Mac OS X package.
static final SharePathError	INSIDE_PUBLIC_FOLDER	A folder inside a public folder can't be shared this way.
static final SharePathError	INSIDE_SHARED_FOLDER	We do not support sharing a folder inside a shared folder.
static final SharePathError	INVALID_PATH	Path is not valid.
static final SharePathError	IS_APP_FOLDER	We do not support sharing an app folder.
static final SharePathError	IS_FAMILY	We do not support sharing the Family folder.
static final SharePathError	IS_FILE	A file is at the specified path.
static final SharePathError	IS_OSX_PACKAGE	We do not support sharing a Mac OS X package.
static final SharePathError	IS_PUBLIC_FOLDER	A public folder can't be shared this way.
static final SharePathError	IS_VAULT	We do not support sharing the Vault folder.
static final SharePathError	IS_VAULT_LOCKED	We do not support sharing a folder inside a locked Vault.
static final SharePathError	OTHER	Catch-all used for unknown tag values returned by the Dropbox servers.

Method Summary

Modifier and Type	Method	Description
static SharePathError	alreadyShared(SharedFolderMetadata value)	Returns an instance of SharePathError that has its tag set to SharePathError.Tag.ALREADY_SHARED.
boolean	equals(Object obj)
SharedFolderMetadata	getAlreadySharedValue()	Folder is already shared.
int	hashCode()
boolean	isAlreadyShared()	Returns true if this instance has the tag SharePathError.Tag.ALREADY_SHARED, false otherwise.
boolean	isContainsAppFolder()	Returns true if this instance has the tag SharePathError.Tag.CONTAINS_APP_FOLDER, false otherwise.
boolean	isContainsSharedFolder()	Returns true if this instance has the tag SharePathError.Tag.CONTAINS_SHARED_FOLDER, false otherwise.
boolean	isContainsTeamFolder()	Returns true if this instance has the tag SharePathError.Tag.CONTAINS_TEAM_FOLDER, false otherwise.
boolean	isInsideAppFolder()	Returns true if this instance has the tag SharePathError.Tag.INSIDE_APP_FOLDER, false otherwise.
boolean	isInsideOsxPackage()	Returns true if this instance has the tag SharePathError.Tag.INSIDE_OSX_PACKAGE, false otherwise.
boolean	isInsidePublicFolder()	Returns true if this instance has the tag SharePathError.Tag.INSIDE_PUBLIC_FOLDER, false otherwise.
boolean	isInsideSharedFolder()	Returns true if this instance has the tag SharePathError.Tag.INSIDE_SHARED_FOLDER, false otherwise.
boolean	isInvalidPath()	Returns true if this instance has the tag SharePathError.Tag.INVALID_PATH, false otherwise.
boolean	isIsAppFolder()	Returns true if this instance has the tag SharePathError.Tag.IS_APP_FOLDER, false otherwise.
boolean	isIsFamily()	Returns true if this instance has the tag SharePathError.Tag.IS_FAMILY, false otherwise.
boolean	isIsFile()	Returns true if this instance has the tag SharePathError.Tag.IS_FILE, false otherwise.
boolean	isIsOsxPackage()	Returns true if this instance has the tag SharePathError.Tag.IS_OSX_PACKAGE, false otherwise.
boolean	isIsPublicFolder()	Returns true if this instance has the tag SharePathError.Tag.IS_PUBLIC_FOLDER, false otherwise.
boolean	isIsVault()	Returns true if this instance has the tag SharePathError.Tag.IS_VAULT, false otherwise.
boolean	isIsVaultLocked()	Returns true if this instance has the tag SharePathError.Tag.IS_VAULT_LOCKED, false otherwise.
boolean	isOther()	Returns true if this instance has the tag SharePathError.Tag.OTHER, false otherwise.
SharePathError.Tag	tag()	Returns the tag for this instance.
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 Details

IS_FILE

public static final SharePathError IS_FILE

A file is at the specified path.

INSIDE_SHARED_FOLDER

public static final SharePathError INSIDE_SHARED_FOLDER

We do not support sharing a folder inside a shared folder.

CONTAINS_SHARED_FOLDER

public static final SharePathError CONTAINS_SHARED_FOLDER

We do not support shared folders that contain shared folders.

CONTAINS_APP_FOLDER

public static final SharePathError CONTAINS_APP_FOLDER

We do not support shared folders that contain app folders.

CONTAINS_TEAM_FOLDER

public static final SharePathError CONTAINS_TEAM_FOLDER

We do not support shared folders that contain team folders.

IS_APP_FOLDER

public static final SharePathError IS_APP_FOLDER

We do not support sharing an app folder.

INSIDE_APP_FOLDER

public static final SharePathError INSIDE_APP_FOLDER

We do not support sharing a folder inside an app folder.

IS_PUBLIC_FOLDER

public static final SharePathError IS_PUBLIC_FOLDER

A public folder can't be shared this way. Use a public link instead.

INSIDE_PUBLIC_FOLDER

public static final SharePathError INSIDE_PUBLIC_FOLDER

A folder inside a public folder can't be shared this way. Use a public link instead.

INVALID_PATH

public static final SharePathError INVALID_PATH

Path is not valid.

IS_OSX_PACKAGE

public static final SharePathError IS_OSX_PACKAGE

We do not support sharing a Mac OS X package.

INSIDE_OSX_PACKAGE

public static final SharePathError INSIDE_OSX_PACKAGE

We do not support sharing a folder inside a Mac OS X package.

IS_VAULT

public static final SharePathError IS_VAULT

We do not support sharing the Vault folder.

IS_VAULT_LOCKED

public static final SharePathError IS_VAULT_LOCKED

We do not support sharing a folder inside a locked Vault.

IS_FAMILY

public static final SharePathError IS_FAMILY

We do not support sharing the Family folder.

OTHER

public static final SharePathError OTHER

Catch-all used for unknown tag values returned by the Dropbox servers.

Receiving a catch-all value typically indicates this SDK version is not up to date. Consider updating your SDK version to handle the new tags.

Method Details

tag

public SharePathError.Tag tag()

Returns the tag for this instance.

This class is a tagged union. Tagged unions instances are always associated to a specific tag. This means only one of the isXyz() methods will return true. Callers are recommended to use the tag value in a switch statement to properly handle the different values for this SharePathError.

If a tag returned by the server is unrecognized by this SDK, the SharePathError.Tag.OTHER value will be used.

Returns:

the tag for this instance.

isIsFile

public boolean isIsFile()

Returns true if this instance has the tag SharePathError.Tag.IS_FILE, false otherwise.

Returns:

true if this instance is tagged as SharePathError.Tag.IS_FILE, false otherwise.

isInsideSharedFolder

public boolean isInsideSharedFolder()

Returns true if this instance has the tag SharePathError.Tag.INSIDE_SHARED_FOLDER, false otherwise.

Returns:

true if this instance is tagged as SharePathError.Tag.INSIDE_SHARED_FOLDER, false otherwise.

isContainsSharedFolder

public boolean isContainsSharedFolder()

Returns true if this instance has the tag SharePathError.Tag.CONTAINS_SHARED_FOLDER, false otherwise.

Returns:

true if this instance is tagged as SharePathError.Tag.CONTAINS_SHARED_FOLDER, false otherwise.

isContainsAppFolder

public boolean isContainsAppFolder()

Returns true if this instance has the tag SharePathError.Tag.CONTAINS_APP_FOLDER, false otherwise.

Returns:

true if this instance is tagged as SharePathError.Tag.CONTAINS_APP_FOLDER, false otherwise.

isContainsTeamFolder

public boolean isContainsTeamFolder()

Returns true if this instance has the tag SharePathError.Tag.CONTAINS_TEAM_FOLDER, false otherwise.

Returns:

true if this instance is tagged as SharePathError.Tag.CONTAINS_TEAM_FOLDER, false otherwise.

isIsAppFolder

public boolean isIsAppFolder()

Returns true if this instance has the tag SharePathError.Tag.IS_APP_FOLDER, false otherwise.

Returns:

true if this instance is tagged as SharePathError.Tag.IS_APP_FOLDER, false otherwise.

isInsideAppFolder

public boolean isInsideAppFolder()

Returns true if this instance has the tag SharePathError.Tag.INSIDE_APP_FOLDER, false otherwise.

Returns:

true if this instance is tagged as SharePathError.Tag.INSIDE_APP_FOLDER, false otherwise.

isIsPublicFolder

public boolean isIsPublicFolder()

Returns true if this instance has the tag SharePathError.Tag.IS_PUBLIC_FOLDER, false otherwise.

Returns:

true if this instance is tagged as SharePathError.Tag.IS_PUBLIC_FOLDER, false otherwise.

isInsidePublicFolder

public boolean isInsidePublicFolder()

Returns true if this instance has the tag SharePathError.Tag.INSIDE_PUBLIC_FOLDER, false otherwise.

Returns:

true if this instance is tagged as SharePathError.Tag.INSIDE_PUBLIC_FOLDER, false otherwise.

isAlreadyShared

public boolean isAlreadyShared()

Returns true if this instance has the tag SharePathError.Tag.ALREADY_SHARED, false otherwise.

Returns:

true if this instance is tagged as SharePathError.Tag.ALREADY_SHARED, false otherwise.

alreadyShared

public static SharePathError alreadyShared(SharedFolderMetadata value)

Returns an instance of SharePathError that has its tag set to SharePathError.Tag.ALREADY_SHARED.

Folder is already shared. Contains metadata about the existing shared folder.

Parameters:

value - value to assign to this instance.

Returns:

Instance of SharePathError with its tag set to SharePathError.Tag.ALREADY_SHARED.

Throws:

IllegalArgumentException - if value is null.

getAlreadySharedValue

public SharedFolderMetadata getAlreadySharedValue()

Folder is already shared. Contains metadata about the existing shared folder.

This instance must be tagged as SharePathError.Tag.ALREADY_SHARED.

Returns:

The SharedFolderMetadata value associated with this instance if isAlreadyShared() is true.

Throws:

IllegalStateException - If isAlreadyShared() is false.

isInvalidPath

public boolean isInvalidPath()

Returns true if this instance has the tag SharePathError.Tag.INVALID_PATH, false otherwise.

Returns:

true if this instance is tagged as SharePathError.Tag.INVALID_PATH, false otherwise.

isIsOsxPackage

public boolean isIsOsxPackage()

Returns true if this instance has the tag SharePathError.Tag.IS_OSX_PACKAGE, false otherwise.

Returns:

true if this instance is tagged as SharePathError.Tag.IS_OSX_PACKAGE, false otherwise.

isInsideOsxPackage

public boolean isInsideOsxPackage()

Returns true if this instance has the tag SharePathError.Tag.INSIDE_OSX_PACKAGE, false otherwise.

Returns:

true if this instance is tagged as SharePathError.Tag.INSIDE_OSX_PACKAGE, false otherwise.

isIsVault

public boolean isIsVault()

Returns true if this instance has the tag SharePathError.Tag.IS_VAULT, false otherwise.

Returns:

true if this instance is tagged as SharePathError.Tag.IS_VAULT, false otherwise.

isIsVaultLocked

public boolean isIsVaultLocked()

Returns true if this instance has the tag SharePathError.Tag.IS_VAULT_LOCKED, false otherwise.

Returns:

true if this instance is tagged as SharePathError.Tag.IS_VAULT_LOCKED, false otherwise.

isIsFamily

public boolean isIsFamily()

Returns true if this instance has the tag SharePathError.Tag.IS_FAMILY, false otherwise.

Returns:

true if this instance is tagged as SharePathError.Tag.IS_FAMILY, false otherwise.

isOther

public boolean isOther()

Returns true if this instance has the tag SharePathError.Tag.OTHER, false otherwise.

Returns:

true if this instance is tagged as SharePathError.Tag.OTHER, false otherwise.

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