de.intarsys.tools.randomaccess.RandomAccessFile Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of isrt Show documentation
The basic runtime tools and interfaces for intarsys components.
There is a newer version: 4.11
/*
 * Copyright (c) 2007, intarsys consulting GmbH
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * - Redistributions of source code must retain the above copyright notice,
 *   this list of conditions and the following disclaimer.
 *
 * - Redistributions in binary form must reproduce the above copyright notice,
 *   this list of conditions and the following disclaimer in the documentation
 *   and/or other materials provided with the distribution.
 *
 * - Neither the name of intarsys nor the names of its contributors may be used
 *   to endorse or promote products derived from this software without specific
 *   prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */
package de.intarsys.tools.randomaccess;

import java.io.File;
import java.io.FileNotFoundException;
import java.io.IOException;
import java.util.logging.Logger;

/**
 * Implements random access to a file.
 */
public class RandomAccessFile extends AbstractRandomAccess {

	/** The logger to be used in this package */
	private static Logger Log = PACKAGE.Log;

	/**
	 * The wrapped RandomAccessFile of the java library
	 */
	private java.io.RandomAccessFile fileAccess;

	/**
	 * Flag if this is used read only
	 */
	private boolean readOnly = false;

	private File file;

	/**
	 * @param file
	 *            to open for random access
	 * @throws FileNotFoundException
	 *             if file was not found or the file is locked by a different
	 *             process
	 */
	public RandomAccessFile(File file) throws IOException {
		this(file, true);
	}

	/**
	 * @param file
	 *            to open for random access
	 * @throws FileNotFoundException
	 *             if file was not found or the file is locked by a different
	 *             process
	 */
	public RandomAccessFile(File file, boolean create) throws IOException {
		this.file = file;
		if (create && !file.exists()) {
			File dir = file.getParentFile();
			if ((dir != null) && !dir.exists()) {
				dir.mkdirs();
			}
			file.createNewFile();
		}
		if (!file.exists()) {
			throw new FileNotFoundException(
					"file does not exist or can't be created");
		}
		if (file.canWrite()) {
			try {
				fileAccess = new java.io.RandomAccessFile(file, "rw");
				return;
			} catch (IOException e) {
				// canWrite() doesn't check for user permissions
				// try again with readonly
			}
		}
		fileAccess = new java.io.RandomAccessFile(file, "r");
		readOnly = true;
	}

	/*
	 * (non-Javadoc)
	 * 
	 * @see de.intarsys.tools.randomaccess.IRandomAccessData#close()
	 */
	public void close() throws IOException {
		if (fileAccess != null) {
			fileAccess.close();
		}
	}

	/*
	 * (non-Javadoc)
	 * 
	 * @see de.intarsys.tools.randomaccess.IRandomAccess#flush()
	 */
	public void flush() throws IOException {
		fileAccess.getChannel().force(true);
	}

	/*
	 * (non-Javadoc)
	 * 
	 * @see de.intarsys.tools.randomaccess.IRandomAccessData#getLength()
	 */
	public long getLength() throws IOException {
		return fileAccess.length();
	}

	/*
	 * (non-Javadoc)
	 * 
	 * @see de.intarsys.tools.randomaccess.IRandomAccessData#getOffset()
	 */
	public long getOffset() throws IOException {
		return fileAccess.getFilePointer();
	}

	/*
	 * (non-Javadoc)
	 * 
	 * @see de.intarsys.tools.randomaccess.IRandomAccessData#isReadOnly()
	 */
	public boolean isReadOnly() {
		return readOnly;
	}

	/*
	 * (non-Javadoc)
	 * 
	 * @see de.intarsys.tools.randomaccess.IRandomAccessData#read()
	 */
	public int read() throws IOException {
		return fileAccess.read();
	}

	/*
	 * (non-Javadoc)
	 * 
	 * @see de.intarsys.tools.randomaccess.IRandomAccessData#read(byte[])
	 */
	public int read(byte[] buffer) throws IOException {
		return fileAccess.read(buffer);
	}

	/*
	 * (non-Javadoc)
	 * 
	 * @see de.intarsys.tools.randomaccess.IRandomAccessData#read(byte[], int,
	 *      int)
	 */
	public int read(byte[] buffer, int start, int numBytes) throws IOException {
		return fileAccess.read(buffer, start, numBytes);
	}

	/*
	 * (non-Javadoc)
	 * 
	 * @see de.intarsys.tools.randomaccess.IRandomAccessData#seek(long)
	 */
	public void seek(long offset) throws IOException {
		fileAccess.seek(offset);
	}

	public void seekBy(long delta) throws IOException {
		seek(fileAccess.getFilePointer() + delta);
	}

	/*
	 * (non-Javadoc)
	 * 
	 * @see de.intarsys.tools.randomaccess.IRandomAccessData#setLength(int)
	 */
	public void setLength(long newLength) throws IOException {
		fileAccess.setLength(newLength);
	}

	/*
	 * (non-Javadoc)
	 * 
	 * @see de.intarsys.tools.randomaccess.IRandomAccessData#write(byte[])
	 */
	public void write(byte[] buffer) throws IOException {
		fileAccess.write(buffer);
	}

	/*
	 * (non-Javadoc)
	 * 
	 * @see de.intarsys.tools.randomaccess.IRandomAccessData#write(byte[], int,
	 *      int)
	 */
	public void write(byte[] buffer, int start, int numBytes)
			throws IOException {
		fileAccess.write(buffer, start, numBytes);
	}

	/*
	 * (non-Javadoc)
	 * 
	 * @see de.intarsys.tools.randomaccess.IRandomAccessData#write(int)
	 */
	public void write(int b) throws IOException {
		fileAccess.write(b);
	}
}