Class PathRootError
- java.lang.Object
-
- com.dropbox.core.v2.common.PathRootError
-
public final class PathRootError 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 classPathRootError.SerializerFor internal use only.static classPathRootError.TagDiscriminating tag type forPathRootError.
-
Field Summary
Fields Modifier and Type Field Description static PathRootErrorNO_PERMISSIONYou don't have permission to access the namespace id in Dropbox-API-Path-Root header.static PathRootErrorOTHERCatch-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 booleanequals(java.lang.Object obj)RootInfogetInvalidRootValue()The root namespace id in Dropbox-API-Path-Root header is not valid.inthashCode()static PathRootErrorinvalidRoot(RootInfo value)Returns an instance ofPathRootErrorthat has its tag set toPathRootError.Tag.INVALID_ROOT.booleanisInvalidRoot()booleanisNoPermission()booleanisOther()PathRootError.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
-
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 aswitchstatement to properly handle the different values for thisPathRootError.If a tag returned by the server is unrecognized by this SDK, the
PathRootError.Tag.OTHERvalue will be used.- Returns:
- the tag for this instance.
-
isInvalidRoot
public boolean isInvalidRoot()
- Returns:
trueif this instance is tagged asPathRootError.Tag.INVALID_ROOT,falseotherwise.
-
invalidRoot
public static PathRootError invalidRoot(RootInfo value)
Returns an instance ofPathRootErrorthat 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
PathRootErrorwith its tag set toPathRootError.Tag.INVALID_ROOT. - Throws:
java.lang.IllegalArgumentException- ifvalueisnull.
-
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
RootInfovalue associated with this instance ifisInvalidRoot()istrue. - Throws:
java.lang.IllegalStateException- IfisInvalidRoot()isfalse.
-
isNoPermission
public boolean isNoPermission()
- Returns:
trueif this instance is tagged asPathRootError.Tag.NO_PERMISSION,falseotherwise.
-
isOther
public boolean isOther()
- Returns:
trueif this instance is tagged asPathRootError.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
-
-