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 * http://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;
020
021/**
022 * Exception thrown by ArchiveStreamFactory if a format is requested/detected that doesn't support streaming.
023 *
024 * @since 1.8
025 */
026public class StreamingNotSupportedException extends ArchiveException {
027
028    private static final long serialVersionUID = 1L;
029
030    private final String format;
031
032    /**
033     * Creates a new StreamingNotSupportedException.
034     *
035     * @param format the format that has been requested/detected.
036     */
037    public StreamingNotSupportedException(final String format) {
038        super("The " + format + " doesn't support streaming.");
039        this.format = format;
040    }
041
042    /**
043     * Gets the format that has been requested/detected.
044     *
045     * @return the format that has been requested/detected.
046     */
047    public String getFormat() {
048        return format;
049    }
050
051}