001/*
002 * Licensed to the Apache Software Foundation (ASF) under one
003 * or more contributor license agreements.  See the NOTICE file
004 * distributed with this work for additional information
005 * regarding copyright ownership.  The ASF licenses this file
006 * to you under the Apache License, Version 2.0 (the
007 * "License"); you may not use this file except in compliance
008 * with the License.  You may obtain a copy of the License at
009 *
010 *   https://www.apache.org/licenses/LICENSE-2.0
011 *
012 * Unless required by applicable law or agreed to in writing,
013 * software distributed under the License is distributed on an
014 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
015 * KIND, either express or implied.  See the License for the
016 * specific language governing permissions and limitations
017 * under the License.
018 */
019package org.apache.commons.compress.archivers.dump;
020
021/**
022 * Invalid Format Exception. There was an error decoding a tape segment header.
023 */
024public class InvalidFormatException extends DumpArchiveException {
025    private static final long serialVersionUID = 1L;
026
027    /**
028     * The offset where the problem was detected.
029     */
030    protected long offset;
031
032    /**
033     * Constructs a {@code InvalidFormatException}.
034     */
035    public InvalidFormatException() {
036        super("there was an error decoding a tape segment");
037    }
038
039    /**
040     * Constructs a {@code InvalidFormatException}.
041     *
042     * @param offset offset where the problem was detected.
043     */
044    public InvalidFormatException(final long offset) {
045        super("there was an error decoding a tape segment header at offset " + offset + ".");
046        this.offset = offset;
047    }
048
049    /**
050     * Gets the offset where the problem was detected.
051     *
052     * @return the offset where the problem was detected.
053     */
054    public long getOffset() {
055        return offset;
056    }
057}