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 * https://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.archivers.dump;
20
21 /**
22 * Invalid Format Exception. There was an error decoding a tape segment header.
23 */
24 public class InvalidFormatException extends DumpArchiveException {
25 private static final long serialVersionUID = 1L;
26
27 /**
28 * The offset where the problem was detected.
29 */
30 protected long offset;
31
32 /**
33 * Constructs a {@code InvalidFormatException}.
34 */
35 public InvalidFormatException() {
36 super("there was an error decoding a tape segment");
37 }
38
39 /**
40 * Constructs a {@code InvalidFormatException}.
41 *
42 * @param offset offset where the problem was detected.
43 */
44 public InvalidFormatException(final long offset) {
45 super("there was an error decoding a tape segment header at offset " + offset + ".");
46 this.offset = offset;
47 }
48
49 /**
50 * Gets the offset where the problem was detected.
51 *
52 * @return the offset where the problem was detected.
53 */
54 public long getOffset() {
55 return offset;
56 }
57 }