Class 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 the 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.

    • 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 return true. Callers are recommended to use the tag value in a switch statement to properly handle the different values for this PathRootError.

        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.
      • invalidRoot

        public static PathRootError invalidRoot​(RootInfo value)
        Returns an instance of PathRootError that has its tag set to PathRootError.Tag.INVALID_ROOT.

        The root namespace id in Dropbox-API-Path-Root header is not valid. The value of this error is use's latest root info.

        Parameters:
        value - value to assign to this instance.
        Returns:
        Instance of PathRootError with its tag set to PathRootError.Tag.INVALID_ROOT.
        Throws:
        java.lang.IllegalArgumentException - if value is null.
      • getInvalidRootValue

        public RootInfo getInvalidRootValue()
        The root namespace id in Dropbox-API-Path-Root header is not valid. The value of this error is use's latest root info.

        This instance must be tagged as PathRootError.Tag.INVALID_ROOT.

        Returns:
        The RootInfo value associated with this instance if isInvalidRoot() is true.
        Throws:
        java.lang.IllegalStateException - If isInvalidRoot() is false.
      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object
      • equals

        public boolean equals​(java.lang.Object obj)
        Overrides:
        equals in class java.lang.Object
      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.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