Package jenkins.util.io

Class CompositeIOException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.io.IOException

jenkins.util.io.CompositeIOException

All Implemented Interfaces:

Serializable

@Restricted(org.kohsuke.accmod.restrictions.NoExternalUse.class)
public class CompositeIOException
extends IOException

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final int	EXCEPTION_LIMIT	The maximum number of exceptions that can be reported by a single CompositeIOException.

Constructor Summary

Constructors

Constructor	Description
CompositeIOException(String message, IOException... exceptions)
CompositeIOException(String message, List<IOException> exceptions)	Construct a new CompositeIOException where the given list of exceptions are added as suppressed exceptions to the new exception.

Method Summary

Modifier and Type	Method	Description
UncheckedIOException	asUncheckedIOException()
List<IOException>	getExceptions()

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

Field Details

EXCEPTION_LIMIT

public static final int EXCEPTION_LIMIT

The maximum number of exceptions that can be reported by a single CompositeIOException.

The number of exceptions is limited to avoid pathological cases where a huge number of exceptions could lead to excessive memory usage. For example, if the number of exceptions was unlimited, a call to Util.deleteRecursive could fail with a CompositeIOException that contains an exception for every single file inside of the directory.

See Also:

• Constant Field Values

Constructor Details

CompositeIOException

public CompositeIOException(String message,
 @NonNull
 List<IOException> exceptions)

Construct a new CompositeIOException where the given list of exceptions are added as suppressed exceptions to the new exception.

If the given list of exceptions is longer than EXCEPTION_LIMIT, the list will be truncated to that length, and a message indicating the number of discarded exceptions will be appended to the original message.

CompositeIOException

public CompositeIOException(String message,
 IOException... exceptions)

See Also:

• CompositeIOException(String, List)

Method Details

getExceptions

public List<IOException> getExceptions()

asUncheckedIOException

public UncheckedIOException asUncheckedIOException()