public final class CreateFolderBatchJobStatus
extends java.lang.Object
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.
Modifier and Type | Class and Description |
---|---|
static class |
CreateFolderBatchJobStatus.Tag
Discriminating tag type for
CreateFolderBatchJobStatus . |
Modifier and Type | Field and Description |
---|---|
static CreateFolderBatchJobStatus |
IN_PROGRESS
The asynchronous job is still in progress.
|
static CreateFolderBatchJobStatus |
OTHER
Catch-all used for unknown tag values returned by the Dropbox servers.
|
Modifier and Type | Method and Description |
---|---|
static CreateFolderBatchJobStatus |
complete(CreateFolderBatchResult value)
Returns an instance of
CreateFolderBatchJobStatus that has its
tag set to CreateFolderBatchJobStatus.Tag.COMPLETE . |
boolean |
equals(java.lang.Object obj) |
static CreateFolderBatchJobStatus |
failed(CreateFolderBatchError value)
Returns an instance of
CreateFolderBatchJobStatus that has its
tag set to CreateFolderBatchJobStatus.Tag.FAILED . |
CreateFolderBatchResult |
getCompleteValue()
The batch create folder has finished.
|
CreateFolderBatchError |
getFailedValue()
The batch create folder has failed.
|
int |
hashCode() |
boolean |
isComplete()
|
boolean |
isFailed()
|
boolean |
isInProgress()
Returns
true if this instance has the tag CreateFolderBatchJobStatus.Tag.IN_PROGRESS , false otherwise. |
boolean |
isOther()
|
CreateFolderBatchJobStatus.Tag |
tag()
Returns the tag for this instance.
|
java.lang.String |
toString() |
java.lang.String |
toStringMultiline()
Returns a String representation of this object formatted for easier
readability.
|
public static final CreateFolderBatchJobStatus IN_PROGRESS
public static final CreateFolderBatchJobStatus OTHER
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.
public CreateFolderBatchJobStatus.Tag tag()
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 CreateFolderBatchJobStatus
.
If a tag returned by the server is unrecognized by this SDK, the
CreateFolderBatchJobStatus.Tag.OTHER
value will be used.
public boolean isInProgress()
true
if this instance has the tag CreateFolderBatchJobStatus.Tag.IN_PROGRESS
, false
otherwise.true
if this instance is tagged as CreateFolderBatchJobStatus.Tag.IN_PROGRESS
, false
otherwise.public boolean isComplete()
true
if this instance is tagged as CreateFolderBatchJobStatus.Tag.COMPLETE
,
false
otherwise.public static CreateFolderBatchJobStatus complete(CreateFolderBatchResult value)
CreateFolderBatchJobStatus
that has its
tag set to CreateFolderBatchJobStatus.Tag.COMPLETE
.
The batch create folder has finished.
value
- value to assign to this instance.CreateFolderBatchJobStatus
with its tag set
to CreateFolderBatchJobStatus.Tag.COMPLETE
.java.lang.IllegalArgumentException
- if value
is null
.public CreateFolderBatchResult getCompleteValue()
This instance must be tagged as CreateFolderBatchJobStatus.Tag.COMPLETE
.
CreateFolderBatchResult
value associated with this
instance if isComplete()
is true
.java.lang.IllegalStateException
- If isComplete()
is false
.public boolean isFailed()
true
if this instance is tagged as CreateFolderBatchJobStatus.Tag.FAILED
,
false
otherwise.public static CreateFolderBatchJobStatus failed(CreateFolderBatchError value)
CreateFolderBatchJobStatus
that has its
tag set to CreateFolderBatchJobStatus.Tag.FAILED
.
The batch create folder has failed.
value
- value to assign to this instance.CreateFolderBatchJobStatus
with its tag set
to CreateFolderBatchJobStatus.Tag.FAILED
.java.lang.IllegalArgumentException
- if value
is null
.public CreateFolderBatchError getFailedValue()
This instance must be tagged as CreateFolderBatchJobStatus.Tag.FAILED
.
CreateFolderBatchError
value associated with this
instance if isFailed()
is true
.java.lang.IllegalStateException
- If isFailed()
is false
.public boolean isOther()
true
if this instance is tagged as CreateFolderBatchJobStatus.Tag.OTHER
,
false
otherwise.public int hashCode()
hashCode
in class java.lang.Object
public boolean equals(java.lang.Object obj)
equals
in class java.lang.Object
public java.lang.String toString()
toString
in class java.lang.Object
public java.lang.String toStringMultiline()
The returned String may contain newlines.