1 /*
2 * Licensed to the Apache Software Foundation (ASF) under one
3 * or more contributor license agreements. See the NOTICE file
4 * distributed with this work for additional information
5 * regarding copyright ownership. The ASF licenses this file
6 * to you under the Apache License, Version 2.0 (the
7 * "License"); you may not use this file except in compliance
8 * with the License. You may obtain a copy of the License at
9 *
10 * http://www.apache.org/licenses/LICENSE-2.0
11 *
12 * Unless required by applicable law or agreed to in writing,
13 * software distributed under the License is distributed on an
14 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15 * KIND, either express or implied. See the License for the
16 * specific language governing permissions and limitations
17 * under the License.
18 */
19 package org.apache.commons.compress;
20
21 import java.io.IOException;
22
23 /**
24 * 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
25 * to allocate a byte array that is larger than the allowable limit.
26 *
27 * @since 1.14
28 */
29 public class MemoryLimitException extends IOException {
30
31 private static final long serialVersionUID = 1L;
32
33 private static String buildMessage(final long memoryNeededInKb, final int memoryLimitInKb) {
34 return memoryNeededInKb + " kb of memory would be needed; limit was " + memoryLimitInKb + " kb. "
35 + "If the file is not corrupt, consider increasing the memory limit.";
36 }
37
38 /** A long instead of int to account for overflow for corrupt files. */
39 private final long memoryNeededInKb;
40
41 private final int memoryLimitInKb;
42
43 public MemoryLimitException(final long memoryNeededInKb, final int memoryLimitInKb) {
44 super(buildMessage(memoryNeededInKb, memoryLimitInKb));
45 this.memoryNeededInKb = memoryNeededInKb;
46 this.memoryLimitInKb = memoryLimitInKb;
47 }
48
49 public MemoryLimitException(final long memoryNeededInKb, final int memoryLimitInKb, final Exception e) {
50 super(buildMessage(memoryNeededInKb, memoryLimitInKb), e);
51 this.memoryNeededInKb = memoryNeededInKb;
52 this.memoryLimitInKb = memoryLimitInKb;
53 }
54
55 public int getMemoryLimitInKb() {
56 return memoryLimitInKb;
57 }
58
59 public long getMemoryNeededInKb() {
60 return memoryNeededInKb;
61 }
62 }