Class CreateFolderBatchJobStatus
- java.lang.Object
-
- com.dropbox.core.v2.files.CreateFolderBatchJobStatus
-
public final class CreateFolderBatchJobStatus extends java.lang.ObjectThis class is an open tagged union. Tagged unions instances are always associated to a specific tag. This means only one of theisAbc()methods will returntrue. You can usetag()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
OTHERvalue will be used.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classCreateFolderBatchJobStatus.TagDiscriminating tag type forCreateFolderBatchJobStatus.
-
Field Summary
Fields Modifier and Type Field Description static CreateFolderBatchJobStatusIN_PROGRESSThe asynchronous job is still in progress.static CreateFolderBatchJobStatusOTHERCatch-all used for unknown tag values returned by the Dropbox servers.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static CreateFolderBatchJobStatuscomplete(CreateFolderBatchResult value)Returns an instance ofCreateFolderBatchJobStatusthat has its tag set toCreateFolderBatchJobStatus.Tag.COMPLETE.booleanequals(java.lang.Object obj)static CreateFolderBatchJobStatusfailed(CreateFolderBatchError value)Returns an instance ofCreateFolderBatchJobStatusthat has its tag set toCreateFolderBatchJobStatus.Tag.FAILED.CreateFolderBatchResultgetCompleteValue()The batch create folder has finished.CreateFolderBatchErrorgetFailedValue()The batch create folder has failed.inthashCode()booleanisComplete()booleanisFailed()booleanisInProgress()Returnstrueif this instance has the tagCreateFolderBatchJobStatus.Tag.IN_PROGRESS,falseotherwise.booleanisOther()CreateFolderBatchJobStatus.Tagtag()Returns the tag for this instance.java.lang.StringtoString()java.lang.StringtoStringMultiline()Returns a String representation of this object formatted for easier readability.
-
-
-
Field Detail
-
IN_PROGRESS
public static final CreateFolderBatchJobStatus IN_PROGRESS
The asynchronous job is still in progress.
-
OTHER
public static final CreateFolderBatchJobStatus 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 Detail
-
tag
public CreateFolderBatchJobStatus.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 returntrue. Callers are recommended to use the tag value in aswitchstatement to properly handle the different values for thisCreateFolderBatchJobStatus.If a tag returned by the server is unrecognized by this SDK, the
CreateFolderBatchJobStatus.Tag.OTHERvalue will be used.- Returns:
- the tag for this instance.
-
isInProgress
public boolean isInProgress()
Returnstrueif this instance has the tagCreateFolderBatchJobStatus.Tag.IN_PROGRESS,falseotherwise.- Returns:
trueif this instance is tagged asCreateFolderBatchJobStatus.Tag.IN_PROGRESS,falseotherwise.
-
isComplete
public boolean isComplete()
- Returns:
trueif this instance is tagged asCreateFolderBatchJobStatus.Tag.COMPLETE,falseotherwise.
-
complete
public static CreateFolderBatchJobStatus complete(CreateFolderBatchResult value)
Returns an instance ofCreateFolderBatchJobStatusthat has its tag set toCreateFolderBatchJobStatus.Tag.COMPLETE.The batch create folder has finished.
- Parameters:
value- value to assign to this instance.- Returns:
- Instance of
CreateFolderBatchJobStatuswith its tag set toCreateFolderBatchJobStatus.Tag.COMPLETE. - Throws:
java.lang.IllegalArgumentException- ifvalueisnull.
-
getCompleteValue
public CreateFolderBatchResult getCompleteValue()
The batch create folder has finished.This instance must be tagged as
CreateFolderBatchJobStatus.Tag.COMPLETE.- Returns:
- The
CreateFolderBatchResultvalue associated with this instance ifisComplete()istrue. - Throws:
java.lang.IllegalStateException- IfisComplete()isfalse.
-
isFailed
public boolean isFailed()
- Returns:
trueif this instance is tagged asCreateFolderBatchJobStatus.Tag.FAILED,falseotherwise.
-
failed
public static CreateFolderBatchJobStatus failed(CreateFolderBatchError value)
Returns an instance ofCreateFolderBatchJobStatusthat has its tag set toCreateFolderBatchJobStatus.Tag.FAILED.The batch create folder has failed.
- Parameters:
value- value to assign to this instance.- Returns:
- Instance of
CreateFolderBatchJobStatuswith its tag set toCreateFolderBatchJobStatus.Tag.FAILED. - Throws:
java.lang.IllegalArgumentException- ifvalueisnull.
-
getFailedValue
public CreateFolderBatchError getFailedValue()
The batch create folder has failed.This instance must be tagged as
CreateFolderBatchJobStatus.Tag.FAILED.- Returns:
- The
CreateFolderBatchErrorvalue associated with this instance ifisFailed()istrue. - Throws:
java.lang.IllegalStateException- IfisFailed()isfalse.
-
isOther
public boolean isOther()
- Returns:
trueif this instance is tagged asCreateFolderBatchJobStatus.Tag.OTHER,falseotherwise.
-
hashCode
public int hashCode()
- Overrides:
hashCodein classjava.lang.Object
-
equals
public boolean equals(java.lang.Object obj)
- Overrides:
equalsin classjava.lang.Object
-
toString
public java.lang.String toString()
- Overrides:
toStringin classjava.lang.Object
-
toStringMultiline
public java.lang.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
-
-