Package org.apache.commons.compress

Class MemoryLimitException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.io.IOException

org.apache.commons.compress.MemoryLimitException

All Implemented Interfaces:

Serializable

public class MemoryLimitException
extends IOException

If a stream checks for estimated memory allocation, and the estimate goes above the memory limit, this is thrown. This can also be thrown if a stream tries to allocate a byte array that is larger than the allowable limit.

Since:

1.14

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
private final int	memoryLimitInKb
private final long	memoryNeededInKb	A long instead of int to account for overflow for corrupt files.
private static final long	serialVersionUID

Constructor Summary

Constructors

Constructor	Description
MemoryLimitException(long memoryNeededInKb, int memoryLimitInKb)
MemoryLimitException(long memoryNeededInKb, int memoryLimitInKb, Exception e)

Method Summary

Modifier and Type	Method	Description
private static String	buildMessage(long memoryNeededInKb, int memoryLimitInKb)
int	getMemoryLimitInKb()
long	getMemoryNeededInKb()

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

serialVersionUID

private static final long serialVersionUID

See Also:

• Constant Field Values

memoryNeededInKb

private final long memoryNeededInKb

A long instead of int to account for overflow for corrupt files.

memoryLimitInKb

private final int memoryLimitInKb

Constructor Details

MemoryLimitException

public MemoryLimitException(long memoryNeededInKb,
 int memoryLimitInKb)

MemoryLimitException

public MemoryLimitException(long memoryNeededInKb,
 int memoryLimitInKb,
 Exception e)

Method Details

buildMessage

private static String buildMessage(long memoryNeededInKb,
 int memoryLimitInKb)

getMemoryLimitInKb

public int getMemoryLimitInKb()

getMemoryNeededInKb

public long getMemoryNeededInKb()