Package org.apache.activemq.artemis.core.io

Class AbstractSequentialFile

java.lang.Object

org.apache.activemq.artemis.core.io.AbstractSequentialFile

All Implemented Interfaces:

SequentialFile

Direct Known Subclasses:

AIOSequentialFile, NIOSequentialFile

public abstract class AbstractSequentialFile
extends Object
implements SequentialFile

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected class	AbstractSequentialFile.LocalBufferObserver

Field Summary

Fields

Modifier and Type	Field	Description
protected final File	directory
protected final SequentialFileFactory	factory
protected File	file
protected long	fileSize
protected final AtomicLong	position
protected TimedBuffer	timedBuffer
protected final TimedBufferObserver	timedBufferObserver	Instead of having AIOSequentialFile implementing the Observer, I have done it on an inner class.

Constructor Summary

Constructors

Constructor	Description
AbstractSequentialFile(File directory, String file, SequentialFileFactory factory, Executor writerExecutor)

Method Summary

Modifier and Type	Method	Description
void	close()
void	copyTo(SequentialFile newFileName)
protected TimedBufferObserver	createTimedBufferObserver()
final void	delete()
final boolean	exists()
final boolean	fits(int size)
protected File	getFile()
final String	getFileName()
File	getJavaFile()	Returns a native File of the file underlying this sequential file.
protected ByteBuffer	newBuffer(int requiredCapacity, boolean zeroed)
long	position()
void	position(long pos)
final void	renameTo(String newFileName)
void	setTimedBuffer(TimedBuffer buffer)
void	write(ActiveMQBuffer bytes, boolean sync)
void	write(ActiveMQBuffer bytes, boolean sync, IOCallback callback)
void	write(EncodingSupport bytes, boolean sync)
void	write(EncodingSupport bytes, boolean sync, IOCallback callback)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.apache.activemq.artemis.core.io.SequentialFile

afterComplete, blockingWriteDirect, calculateBlockStart, cloneFile, close, fill, isOpen, map, open, open, read, read, size, sync, writeDirect, writeDirect

Field Details

file

protected File file

directory

protected final File directory

factory

protected final SequentialFileFactory factory

fileSize

protected long fileSize

position

protected final AtomicLong position

timedBuffer

protected TimedBuffer timedBuffer

timedBufferObserver

protected final TimedBufferObserver timedBufferObserver

Instead of having AIOSequentialFile implementing the Observer, I have done it on an inner class. This is the class returned to the factory when the file is being activated.

Constructor Details

AbstractSequentialFile

public AbstractSequentialFile(File directory,
 String file,
 SequentialFileFactory factory,
 Executor writerExecutor)

Method Details

createTimedBufferObserver

protected TimedBufferObserver createTimedBufferObserver()

exists

public final boolean exists()

Specified by:

exists in interface SequentialFile

getFileName

public final String getFileName()

Specified by:

getFileName in interface SequentialFile

delete

public final void delete()
                  throws IOException,
InterruptedException,
ActiveMQException

Specified by:

delete in interface SequentialFile

Throws:

IOException

InterruptedException

ActiveMQException

copyTo

public void copyTo(SequentialFile newFileName)
            throws Exception

Specified by:

copyTo in interface SequentialFile

Throws:

Exception

position

public void position(long pos)
              throws IOException

Specified by:

position in interface SequentialFile

Throws:

IOException - only declare exception due to signature. Sub-class needs it.

position

public long position()

Specified by:

position in interface SequentialFile

renameTo

public final void renameTo(String newFileName)
                    throws IOException,
InterruptedException,
ActiveMQException

Specified by:

renameTo in interface SequentialFile

Throws:

IOException

InterruptedException

ActiveMQException

close

public void close()
           throws IOException,
InterruptedException,
ActiveMQException

Specified by:

close in interface SequentialFile

Throws:

IOException - we declare throwing IOException because sub-classes need to do it

InterruptedException

ActiveMQException

fits

public final boolean fits(int size)

Specified by:

fits in interface SequentialFile

setTimedBuffer

public void setTimedBuffer(TimedBuffer buffer)

Specified by:

setTimedBuffer in interface SequentialFile

write

public void write(ActiveMQBuffer bytes,
 boolean sync,
 IOCallback callback)
           throws IOException

Specified by:

write in interface SequentialFile

Throws:

IOException

write

public void write(ActiveMQBuffer bytes,
 boolean sync)
           throws IOException,
InterruptedException,
ActiveMQException

Specified by:

write in interface SequentialFile

Throws:

IOException

InterruptedException

ActiveMQException

write

public void write(EncodingSupport bytes,
 boolean sync,
 IOCallback callback)

Specified by:

write in interface SequentialFile

write

public void write(EncodingSupport bytes,
 boolean sync)
           throws InterruptedException,
ActiveMQException

Specified by:

write in interface SequentialFile

Throws:

InterruptedException

ActiveMQException

getFile

protected File getFile()

newBuffer

protected ByteBuffer newBuffer(int requiredCapacity,
 boolean zeroed)

getJavaFile

public File getJavaFile()

Description copied from interface: SequentialFile

Returns a native File of the file underlying this sequential file.

Specified by:

getJavaFile in interface SequentialFile

Returns:

a native File of the file underlying this sequential file