Class PreviewError


  • public final class PreviewError
    extends java.lang.Object
    This class is a 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.
    • Field Detail

      • IN_PROGRESS

        public static final PreviewError IN_PROGRESS
        This preview generation is still in progress and the file is not ready for preview yet.
      • UNSUPPORTED_EXTENSION

        public static final PreviewError UNSUPPORTED_EXTENSION
        The file extension is not supported preview generation.
      • UNSUPPORTED_CONTENT

        public static final PreviewError UNSUPPORTED_CONTENT
        The file content is not supported for preview generation.
    • Method Detail

      • tag

        public PreviewError.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 PreviewError.

        Returns:
        the tag for this instance.
      • path

        public static PreviewError path​(LookupError value)
        Returns an instance of PreviewError that has its tag set to PreviewError.Tag.PATH.

        An error occurs when downloading metadata for the file.

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

        public LookupError getPathValue()
        An error occurs when downloading metadata for the file.

        This instance must be tagged as PreviewError.Tag.PATH.

        Returns:
        The LookupError value associated with this instance if isPath() is true.
        Throws:
        java.lang.IllegalStateException - If isPath() 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