Class PathRootError
- java.lang.Object
-
- com.dropbox.core.v2.common.PathRootError
-
public final class PathRootError 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
PathRootError.Serializer
For internal use only.static class
PathRootError.Tag
Discriminating tag type forPathRootError
.
-
Field Summary
Fields Modifier and Type Field Description static PathRootError
NO_PERMISSION
You don't have permission to access the namespace id in Dropbox-API-Path-Root header.static PathRootError
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)
RootInfo
getInvalidRootValue()
The root namespace id in Dropbox-API-Path-Root header is not valid.int
hashCode()
static PathRootError
invalidRoot(RootInfo value)
Returns an instance ofPathRootError
that has its tag set toPathRootError.Tag.INVALID_ROOT
.boolean
isInvalidRoot()
boolean
isNoPermission()
boolean
isOther()
PathRootError.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.
-
-
-
Field Detail
-
NO_PERMISSION
public static final PathRootError NO_PERMISSION
You don't have permission to access the namespace id in Dropbox-API-Path-Root header.
-
OTHER
public static final PathRootError 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 PathRootError.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 thisPathRootError
.If a tag returned by the server is unrecognized by this SDK, the
PathRootError.Tag.OTHER
value will be used.- Returns:
- the tag for this instance.
-
isInvalidRoot
public boolean isInvalidRoot()
- Returns:
true
if this instance is tagged asPathRootError.Tag.INVALID_ROOT
,false
otherwise.
-
invalidRoot
public static PathRootError invalidRoot(RootInfo value)
Returns an instance ofPathRootError
that has its tag set toPathRootError.Tag.INVALID_ROOT
.The root namespace id in Dropbox-API-Path-Root header is not valid. The value of this error is the user's latest root info.
- Parameters:
value
- value to assign to this instance.- Returns:
- Instance of
PathRootError
with its tag set toPathRootError.Tag.INVALID_ROOT
. - Throws:
java.lang.IllegalArgumentException
- ifvalue
isnull
.
-
getInvalidRootValue
public RootInfo getInvalidRootValue()
The root namespace id in Dropbox-API-Path-Root header is not valid. The value of this error is the user's latest root info.This instance must be tagged as
PathRootError.Tag.INVALID_ROOT
.- Returns:
- The
RootInfo
value associated with this instance ifisInvalidRoot()
istrue
. - Throws:
java.lang.IllegalStateException
- IfisInvalidRoot()
isfalse
.
-
isNoPermission
public boolean isNoPermission()
- Returns:
true
if this instance is tagged asPathRootError.Tag.NO_PERMISSION
,false
otherwise.
-
isOther
public boolean isOther()
- Returns:
true
if this instance is tagged asPathRootError.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
-
-