com.portal.pcm

Class FileBuffer

java.lang.Object

com.portal.pcm.Buffer

com.portal.pcm.FileBuffer

public class FileBuffer
extends Buffer

The FileBuffer subclass of Buffer is used when the buffered information is to be stored in an external file.

Constructor Summary

Constructors

Constructor and Description
FileBuffer(java.io.File file, boolean forRead) Creates an instance of a Buffer.
FileBuffer(java.io.File file, boolean forRead, int offset) Creates an instance of a Buffer.
FileBuffer(java.lang.String fileName, boolean forRead) Creates an instance of a Buffer.
FileBuffer(java.lang.String fileName, boolean forRead, int offset) Creates an instance of a Buffer.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getFilename() Gets the file name and path of the file.
java.io.InputStream	getInputStream() Gets an InputStream to read buffer information.
java.io.OutputStream	getOutputStream() Gets an OutputStream to write buffer information.
long	getSize() Gets the buffer size.

Methods inherited from class com.portal.pcm.Buffer

getOffset, isReadBuffer, setOffset, setReadFlag, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

FileBuffer

public FileBuffer(java.io.File file,
                  boolean forRead,
                  int offset)
           throws EBufException

Creates an instance of a Buffer.

Parameters:

file - File object

forRead - boolean value indicating whether to read the file

Throws:

EBufException - when an error occurs

FileBuffer

public FileBuffer(java.io.File file,
                  boolean forRead)
           throws EBufException

Creates an instance of a Buffer.

Parameters:

file - File object

forRead - boolean value indicating whether to read the file

Throws:

EBufException - when an error occurs

FileBuffer

public FileBuffer(java.lang.String fileName,
                  boolean forRead,
                  int offset)
           throws EBufException

Creates an instance of a Buffer.

Throws:

EBufException

FileBuffer

public FileBuffer(java.lang.String fileName,
                  boolean forRead)
           throws EBufException

Creates an instance of a Buffer.

Parameters:

fileName - String name of the file

forRead - boolean value indicating whether to read the file

Throws:

EBufException - when an error occurs

Method Detail

getSize

public long getSize()

Gets the buffer size.

Specified by:

getSize in class Buffer

Returns:

The buffer size.

getInputStream

public java.io.InputStream getInputStream()
                                   throws java.io.IOException

Gets an InputStream to read buffer information.

Specified by:

getInputStream in class Buffer

Returns:

An InputStream object.

Throws:

java.io.IOException

getOutputStream

public java.io.OutputStream getOutputStream()
                                     throws java.io.IOException

Gets an OutputStream to write buffer information.

Specified by:

getOutputStream in class Buffer

Returns:

An OutputStream object.

Throws:

java.io.IOException

getFilename

public java.lang.String getFilename()

Gets the file name and path of the file.

Returns:

The file path as a string.