org.xadisk.filesystem.exceptions.FileUnderUseException Maven / Gradle / Ivy
/*
Copyright © 2010, Nitin Verma (project owner for XADisk https://xadisk.dev.java.net/). All rights reserved.
This source code is being made available to the public under the terms specified in the license
"Eclipse Public License 1.0" located at http://www.opensource.org/licenses/eclipse-1.0.php.
*/
package org.xadisk.filesystem.exceptions;
import org.xadisk.bridge.proxies.interfaces.XADiskBasicIOOperations;
import org.xadisk.bridge.proxies.interfaces.XAFileInputStream;
import org.xadisk.bridge.proxies.interfaces.XAFileOutputStream;
/**
* This exception is thrown by {@link XADiskBasicIOOperations#deleteFile(java.io.File)
* deleteFile} and {@link XADiskBasicIOOperations#moveFile(java.io.File, java.io.File)
* moveFile} operations when the to-be-deleted file is being read/written inside the
* current transaction, i.e. there is a {@link XAFileInputStream} or
* {@link XAFileOutputStream} opened for the file by the current transaction.
* This exception is also thrown by
* {@link XADiskBasicIOOperations#createXAFileOutputStream(java.io.File, boolean) createXAFileOutputStream}
* when the heavyWrite parameter is true, but another output stream ({@link XAFileOutputStream})
* is open for the same file in current transaction in non-heavyWrite mode.
*
* @since 1.0
*/
public class FileUnderUseException extends XAApplicationException {
private String path;
private boolean dueToNonHeavyWriteModeOutputStream;
public FileUnderUseException(String path, boolean dueToNonHeavyWriteModeOutputStream) {
this.path = path;
this.dueToNonHeavyWriteModeOutputStream = dueToNonHeavyWriteModeOutputStream;
}
@Override
public String getMessage() {
if(dueToNonHeavyWriteModeOutputStream) {
return "The file [" +path+ "] being accessed already has an output stream open to it in"
+ "non-heavyWrite mode by the current transaction.";
} else {
return "The file [" +path+ "] being deleted has an input/output stream open to it "
+ "by the current transaction.";
}
}
/**
* Returns the path of the file upon which the i/o operation could not succeed.
* @return the path of the file.
*/
public String getPath() {
return path;
}
/**
* This method returns true only and only when this exception is thrown by
* {@link XADiskBasicIOOperations#createXAFileOutputStream(java.io.File, boolean) createXAFileOutputStream}
* with the heavyWrite parameter as true, but another output stream ({@link XAFileOutputStream})
* is open for the same file in current transaction in non-heavyWrite mode.
* @return true, if thrown by {@link XADiskBasicIOOperations#createXAFileOutputStream(java.io.File, boolean)
* createXAFileOutputStream}; false otherwise.
*/
public boolean isDueToNonHeavyWriteModeOutputStream() {
return dueToNonHeavyWriteModeOutputStream;
}
}