/*
* JBoss, Home of Professional Open Source
* Copyright 2005-2008, Red Hat Middleware LLC, and individual contributors
* by the @authors tag. See the copyright.txt in the distribution for a
* full listing of individual contributors.
*
* This is free software; you can redistribute it and/or modify it
* under the terms of the GNU Lesser General Public License as
* published by the Free Software Foundation; either version 2.1 of
* the License, or (at your option) any later version.
*
* This software is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this software; if not, write to the Free
* Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
* 02110-1301 USA, or see the FSF site: http://www.fsf.org.
*/
package org.jboss.messaging.core.journal;
import java.nio.ByteBuffer;
/**
*
* A SequentialFile
*
* @author <a href="mailto:tim.fox@jboss.com">Tim Fox</a>
* @author <a href="mailto:clebert.suconic@jboss.com">Clebert Suconic</a>
*
*/
public interface SequentialFile
{
/*
* Creates the file if it doesn't already exist, then opens it
*/
void open() throws Exception;
/**
* For certain operations (like loading) we don't need open the file with full maxIO
* @param maxIO
* @throws Exception
*/
void open(int maxIO) throws Exception;
void setBufferCallback(BufferCallback callback);
int getAlignment() throws Exception;
int calculateBlockStart(int position) throws Exception;
String getFileName();
void fill(int position, int size, byte fillCharacter) throws Exception;
void delete() throws Exception;
int write(ByteBuffer bytes, IOCallback callback) throws Exception;
int write(ByteBuffer bytes, boolean sync) throws Exception;
int read(ByteBuffer bytes, IOCallback callback) throws Exception;
int read(ByteBuffer bytes) throws Exception;
void position(int pos) throws Exception;
int position() throws Exception;
void close() throws Exception;
void sync() throws Exception;
long size() throws Exception;
}