Class ListFolderError
- java.lang.Object
-
- com.dropbox.core.v2.files.ListFolderError
-
public final class ListFolderError extends java.lang.Object
This 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
OTHER
value will be used.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
ListFolderError.Tag
Discriminating tag type forListFolderError
.
-
Field Summary
Fields Modifier and Type Field Description static ListFolderError
OTHER
Catch-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 boolean
equals(java.lang.Object obj)
LookupError
getPathValue()
This instance must be tagged asListFolderError.Tag.PATH
.TemplateError
getTemplateErrorValue()
This instance must be tagged asListFolderError.Tag.TEMPLATE_ERROR
.int
hashCode()
boolean
isOther()
boolean
isPath()
boolean
isTemplateError()
static ListFolderError
path(LookupError value)
Returns an instance ofListFolderError
that has its tag set toListFolderError.Tag.PATH
.ListFolderError.Tag
tag()
Returns the tag for this instance.static ListFolderError
templateError(TemplateError value)
Returns an instance ofListFolderError
that has its tag set toListFolderError.Tag.TEMPLATE_ERROR
.java.lang.String
toString()
java.lang.String
toStringMultiline()
Returns a String representation of this object formatted for easier readability.
-
-
-
Field Detail
-
OTHER
public static final ListFolderError 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 ListFolderError.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 aswitch
statement to properly handle the different values for thisListFolderError
.If a tag returned by the server is unrecognized by this SDK, the
ListFolderError.Tag.OTHER
value will be used.- Returns:
- the tag for this instance.
-
isPath
public boolean isPath()
- Returns:
true
if this instance is tagged asListFolderError.Tag.PATH
,false
otherwise.
-
path
public static ListFolderError path(LookupError value)
- Parameters:
value
- value to assign to this instance.- Returns:
- Instance of
ListFolderError
with its tag set toListFolderError.Tag.PATH
. - Throws:
java.lang.IllegalArgumentException
- ifvalue
isnull
.
-
getPathValue
public LookupError getPathValue()
This instance must be tagged asListFolderError.Tag.PATH
.- Returns:
- The
LookupError
value associated with this instance ifisPath()
istrue
. - Throws:
java.lang.IllegalStateException
- IfisPath()
isfalse
.
-
isTemplateError
public boolean isTemplateError()
- Returns:
true
if this instance is tagged asListFolderError.Tag.TEMPLATE_ERROR
,false
otherwise.
-
templateError
public static ListFolderError templateError(TemplateError value)
Returns an instance ofListFolderError
that has its tag set toListFolderError.Tag.TEMPLATE_ERROR
.None
- Parameters:
value
- value to assign to this instance.- Returns:
- Instance of
ListFolderError
with its tag set toListFolderError.Tag.TEMPLATE_ERROR
. - Throws:
java.lang.IllegalArgumentException
- ifvalue
isnull
.
-
getTemplateErrorValue
public TemplateError getTemplateErrorValue()
This instance must be tagged asListFolderError.Tag.TEMPLATE_ERROR
.- Returns:
- The
TemplateError
value associated with this instance ifisTemplateError()
istrue
. - Throws:
java.lang.IllegalStateException
- IfisTemplateError()
isfalse
.
-
isOther
public boolean isOther()
- Returns:
true
if this instance is tagged asListFolderError.Tag.OTHER
,false
otherwise.
-
hashCode
public int hashCode()
- Overrides:
hashCode
in classjava.lang.Object
-
equals
public boolean equals(java.lang.Object obj)
- Overrides:
equals
in classjava.lang.Object
-
toString
public java.lang.String toString()
- Overrides:
toString
in 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
-
-