Package com.dropbox.core.v2.riviera

Class FileIdOrUrl

java.lang.Object

com.dropbox.core.v2.riviera.FileIdOrUrl

public final class FileIdOrUrl
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	FileIdOrUrl.Tag	Discriminating tag type for FileIdOrUrl.

Field Summary

Fields

Modifier and Type	Field	Description
static final FileIdOrUrl	OTHER	Catch-all used for unknown tag values returned by the Dropbox servers.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
static FileIdOrUrl	fileId(String value)	Returns an instance of FileIdOrUrl that has its tag set to FileIdOrUrl.Tag.FILE_ID.
String	getFileIdValue()	This instance must be tagged as FileIdOrUrl.Tag.FILE_ID.
String	getPathValue()	This instance must be tagged as FileIdOrUrl.Tag.PATH.
String	getUrlValue()	This instance must be tagged as FileIdOrUrl.Tag.URL.
int	hashCode()
boolean	isFileId()	Returns true if this instance has the tag FileIdOrUrl.Tag.FILE_ID, false otherwise.
boolean	isOther()	Returns true if this instance has the tag FileIdOrUrl.Tag.OTHER, false otherwise.
boolean	isPath()	Returns true if this instance has the tag FileIdOrUrl.Tag.PATH, false otherwise.
boolean	isUrl()	Returns true if this instance has the tag FileIdOrUrl.Tag.URL, false otherwise.
static FileIdOrUrl	path(String value)	Returns an instance of FileIdOrUrl that has its tag set to FileIdOrUrl.Tag.PATH.
FileIdOrUrl.Tag	tag()	Returns the tag for this instance.
String	toString()
String	toStringMultiline()	Returns a String representation of this object formatted for easier readability.
static FileIdOrUrl	url(String value)	Returns an instance of FileIdOrUrl that has its tag set to FileIdOrUrl.Tag.URL.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

OTHER

public static final FileIdOrUrl 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 FileIdOrUrl.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 FileIdOrUrl.

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

Returns:

the tag for this instance.

isFileId

public boolean isFileId()

Returns true if this instance has the tag FileIdOrUrl.Tag.FILE_ID, false otherwise.

Returns:

true if this instance is tagged as FileIdOrUrl.Tag.FILE_ID, false otherwise.

fileId

public static FileIdOrUrl fileId(String value)

Returns an instance of FileIdOrUrl that has its tag set to FileIdOrUrl.Tag.FILE_ID.

None

Parameters:

value - value to assign to this instance.

Returns:

Instance of FileIdOrUrl with its tag set to FileIdOrUrl.Tag.FILE_ID.

Throws:

IllegalArgumentException - if value is null.

getFileIdValue

public String getFileIdValue()

This instance must be tagged as FileIdOrUrl.Tag.FILE_ID.

Returns:

The String value associated with this instance if isFileId() is true.

Throws:

IllegalStateException - If isFileId() is false.

isUrl

public boolean isUrl()

Returns true if this instance has the tag FileIdOrUrl.Tag.URL, false otherwise.

Returns:

true if this instance is tagged as FileIdOrUrl.Tag.URL, false otherwise.

url

public static FileIdOrUrl url(String value)

Returns an instance of FileIdOrUrl that has its tag set to FileIdOrUrl.Tag.URL.

None

Parameters:

value - value to assign to this instance.

Returns:

Instance of FileIdOrUrl with its tag set to FileIdOrUrl.Tag.URL.

Throws:

IllegalArgumentException - if value is null.

getUrlValue

public String getUrlValue()

This instance must be tagged as FileIdOrUrl.Tag.URL.

Returns:

The String value associated with this instance if isUrl() is true.

Throws:

IllegalStateException - If isUrl() is false.

isPath

public boolean isPath()

Returns true if this instance has the tag FileIdOrUrl.Tag.PATH, false otherwise.

Returns:

true if this instance is tagged as FileIdOrUrl.Tag.PATH, false otherwise.

path

public static FileIdOrUrl path(String value)

Returns an instance of FileIdOrUrl that has its tag set to FileIdOrUrl.Tag.PATH.

None

Parameters:

value - value to assign to this instance.

Returns:

Instance of FileIdOrUrl with its tag set to FileIdOrUrl.Tag.PATH.

Throws:

IllegalArgumentException - if value is null.

getPathValue

public String getPathValue()

This instance must be tagged as FileIdOrUrl.Tag.PATH.

Returns:

The String value associated with this instance if isPath() is true.

Throws:

IllegalStateException - If isPath() is false.

isOther

public boolean isOther()

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

Returns:

true if this instance is tagged as FileIdOrUrl.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