Package org.apache.commons.compress.archivers

Class ArchiveException

    • Constructor Summary

      Constructors 
      Constructor Description
      ArchiveException()
      Constructs an ArchiveException with null as its error detail message.
      ArchiveException​(java.lang.String message)
      Constructs a new exception with the specified detail message.
      ArchiveException​(java.lang.String message, java.lang.Exception cause)
      Deprecated.
      Use ArchiveException(String, Throwable).
      ArchiveException​(java.lang.String message, java.lang.Throwable cause)
      Constructs a new exception with the specified detail message and cause.
      ArchiveException​(java.lang.Throwable cause)
      Constructs a ArchiveException with the specified cause and a detail message.

    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static <T> T requireNonNull​(T obj, java.util.function.Supplier<java.lang.String> messageSupplier)
      Checks that the specified object reference is not null and throws a customized ArchiveException if it is.

      • Methods inherited from class java.lang.Throwable

        addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

    • Constructor Detail

      • ArchiveException

        public ArchiveException()
        Constructs an ArchiveException with null as its error detail message.
        Since:
        1.28.0

      • ArchiveException

        public ArchiveException​(java.lang.String message)
        Constructs a new exception with the specified detail message. The cause is not initialized.
        Parameters:
        message - The message (which is saved for later retrieval by the Throwable.getMessage() method).

      • ArchiveException

        @Deprecated
public ArchiveException​(java.lang.String message,
                        java.lang.Exception cause)
        Deprecated.
        Use ArchiveException(String, Throwable).
        Constructs a new exception with the specified detail message and cause.
        Parameters:
        message - The message (which is saved for later retrieval by the Throwable.getMessage() method).
        cause - The cause (which is saved for later retrieval by the Throwable.getCause() method). A null value indicates that the cause is nonexistent or unknown.

      • ArchiveException

        public ArchiveException​(java.lang.String message,
                        java.lang.Throwable cause)
        Constructs a new exception with the specified detail message and cause.
        Parameters:
        message - The message (which is saved for later retrieval by the Throwable.getMessage() method).
        cause - The cause (which is saved for later retrieval by the Throwable.getCause() method). A null value indicates that the cause is nonexistent or unknown.
        Since:
        1.28.0

      • ArchiveException

        public ArchiveException​(java.lang.Throwable cause)
        Constructs a ArchiveException with the specified cause and a detail message.
        Parameters:
        cause - The cause (which is saved for later retrieval by the Throwable.getCause() method). (A null value is permitted, and indicates that the cause is nonexistent or unknown.)
        Since:
        1.28.0

    • Method Detail

      • requireNonNull

        public static <T> T requireNonNull​(T obj,
                                   java.util.function.Supplier<java.lang.String> messageSupplier)
                            throws ArchiveException
        Checks that the specified object reference is not null and throws a customized ArchiveException if it is. *
        Type Parameters:
        T - the type of the reference.
        Parameters:
        obj - the object reference to check for nullity.
        messageSupplier - supplier of the detail message to be used in the event that a ArchiveException is thrown
        Returns:
        obj if not null
        Throws:
        ArchiveException - if obj is null
        Since:
        1.28.0