org.adroitlogic.x.feature.filestore.impl

Class MessageFileEntity

java.lang.Object

org.adroitlogic.x.feature.filestore.impl.MessageFileEntity

All Implemented Interfaces:

AutoCloseable, XMessageFileEntity

public class MessageFileEntity
extends Object
implements XMessageFileEntity

Implementation of XMessageFileEntity which wraps MessageFile instance in order to provide the entity that used in the message format MessageFileFormat

Since:

1.0.0

Author:

Sudheera Palihakkara

Method Summary

Modifier and Type	Method and Description
void	close()
String	getAbsolutePath() Gets the absolute path of the file system of the XMessageFile's underlying file
String	getFileName() Gets the name of the underlying XMessageFile
FileStoreFeature	getFileStoreFeature() Gets the FileStoreFeature instance which is originally created the MessageFileEntity
InputStream	getInputStream() Gets a new FileInputStream to the underlying MessageFile's file each invocation to this method.
OutputStream	getOutputStream() Gets a new FileOutputStream to the underlying MessageFile's file each invocation to this method.
FileChannel	getReadFileChannel() Gets a FileChannel to the underlying MessageFile file with read permissions, multiple calls to this method will not create a new channel each time, instead it will return the same read channel which is cached at the MessageFile's level
FileChannel	getWriteFileChannel() Gets a FileChannel to the underlying MessageFile file with write permissions, multiple calls to this method will not create a new channel each time, instead it will return the same write channel which is cached at the MessageFile's level
long	length() Gets the length of the underlying XMessageFile

Methods inherited from class java.lang.Object

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

Method Detail

getOutputStream

public OutputStream getOutputStream()
                             throws FileReleasedException,
                                    FileNotFoundException

Description copied from interface: XMessageFileEntity

Gets a new FileOutputStream to the underlying MessageFile's file each invocation to this method. returned output stream must be closed at the end of the use.

Specified by:

getOutputStream in interface XMessageFileEntity

Returns:

a FileOutputStream to the file

Throws:

FileReleasedException - if file is already released

FileNotFoundException - if file is not found

getReadFileChannel

public FileChannel getReadFileChannel()
                               throws FileReleasedException

Description copied from interface: XMessageFileEntity

Gets a FileChannel to the underlying MessageFile file with read permissions, multiple calls to this method will not create a new channel each time, instead it will return the same read channel which is cached at the MessageFile's level

Specified by:

getReadFileChannel in interface XMessageFileEntity

Returns:

a readable channel which positioned to the beginning of the file for the first invocation for this method

Throws:

FileReleasedException - if file is already released

getWriteFileChannel

public FileChannel getWriteFileChannel()
                                throws FileReleasedException

Description copied from interface: XMessageFileEntity

Gets a FileChannel to the underlying MessageFile file with write permissions, multiple calls to this method will not create a new channel each time, instead it will return the same write channel which is cached at the MessageFile's level

Specified by:

getWriteFileChannel in interface XMessageFileEntity

Returns:

a writable channel which positioned to the beginning of the file for the first invocation for this method

Throws:

FileReleasedException - if file is already released

getInputStream

public InputStream getInputStream()
                           throws FileReleasedException,
                                  FileNotFoundException

Description copied from interface: XMessageFileEntity

Gets a new FileInputStream to the underlying MessageFile's file each invocation to this method. returned input stream must be closed at the end of the use.

Specified by:

getInputStream in interface XMessageFileEntity

Returns:

a FileInputStream to the file

Throws:

FileReleasedException - if file is already released

FileNotFoundException - if file is not found

getFileStoreFeature

public FileStoreFeature getFileStoreFeature()

Description copied from interface: XMessageFileEntity

Gets the FileStoreFeature instance which is originally created the MessageFileEntity

Specified by:

getFileStoreFeature in interface XMessageFileEntity

Returns:

a instance of FileStoreFeature

length

public long length()
            throws FileReleasedException

Description copied from interface: XMessageFileEntity

Gets the length of the underlying XMessageFile

Specified by:

length in interface XMessageFileEntity

Returns:

file length

Throws:

FileReleasedException - if file is already released

getFileName

public String getFileName()

Description copied from interface: XMessageFileEntity

Gets the name of the underlying XMessageFile

Specified by:

getFileName in interface XMessageFileEntity

Returns:

file name

getAbsolutePath

public String getAbsolutePath()

Description copied from interface: XMessageFileEntity

Gets the absolute path of the file system of the XMessageFile's underlying file

Specified by:

getAbsolutePath in interface XMessageFileEntity

Returns:

absolute path of the file

close

public void close()
           throws Exception

Specified by:

close in interface AutoCloseable

Throws:

Exception