de.schlichtherle.io.ArchiveBusyException Maven / Gradle / Ivy
/*
* Copyright (C) 2005-2010 Schlichtherle IT Services
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package de.schlichtherle.io;
/**
* Thrown if an archive file could not get updated because some input or
* output streams for its entries are still open.
* The canonical path name of the archive file is provided as the detail
* message.
*
* In order to recover from this exception, client applications may call
* {@link File#umount()} or {@link File#update()} in order to force all
* entry streams for all archive files to close and prepare to catch the
* resulting {@link ArchiveBusyWarningException}.
* A subsequent try to create the archive entry stream will then succeed
* unless other exceptional conditions apply.
* However, if the client application is still using a disconnected stream,
* it will receive an {@link ArchiveEntryStreamClosedException} on the next
* call to any other method than {@code close()}.
*
* @see Using Archive Entry Streams
* @see File#umount
* @see File#update
* @author Christian Schlichtherle
* @version $Id: ArchiveBusyException.java,v 1.4 2010/08/20 13:09:42 christian_schlichtherle Exp $
* @since TrueZIP 6.0
*/
public class ArchiveBusyException extends ArchiveException {
ArchiveBusyException(ArchiveException priorException, String cPath) {
super(priorException, cPath);
}
// TODO: Remove this.
/**
* @deprecated You should not use this constructor.
* It will vanish in the next major version.
*/
public ArchiveBusyException(
ArchiveException priorException, java.io.File target) {
super(priorException, target.getPath());
assert target.isAbsolute();
}
public int getPriority() {
return -2;
}
}