com.portal.pcm

Class Buffer

java.lang.Object

com.portal.pcm.Buffer

Direct Known Subclasses:

ByteBuffer, FileBuffer

public abstract class Buffer
extends Object

The Buffer class is used to encapsulate the Portal FLDT_BUF functionality.

Author:

Larry Lynch-Freshner

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Buffer() Create an instance of a Buffer.
protected	Buffer(int offset, boolean forRead) Create an instance of a Buffer.

Method Summary

Modifier and Type	Method and Description
abstract InputStream	getInputStream() Gets an InputStream to read buffer information.
int	getOffset() Get the buffer offset value.
abstract OutputStream	getOutputStream() Gets an OutputStream to write buffer information.
abstract long	getSize() Gets the buffer size.
boolean	isReadBuffer() Returns true if the buffer is to be used to read data from the database.
void	setOffset(int offset) Set the buffer offset value.
void	setReadFlag(boolean forRead) Sets the read flag to indicate whether or not data should be read into the buffer from the database, or written from the buffer to the DB.
String	toString() Gets a string representation of this byte buffer.

Methods inherited from class java.lang.Object

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

Constructor Detail

Buffer

protected Buffer(int offset,
                 boolean forRead)

Create an instance of a Buffer.

Buffer

protected Buffer()

Create an instance of a Buffer.

Method Detail

getOffset

public int getOffset()

Get the buffer offset value.

Returns:

The Offset as an int.

setOffset

public void setOffset(int offset)

Set the buffer offset value.

Parameters:

offset - The new offset value.

isReadBuffer

public boolean isReadBuffer()

Returns true if the buffer is to be used to read data from the database.

Returns:

true if database info is to be read into file.

setReadFlag

public void setReadFlag(boolean forRead)

Sets the read flag to indicate whether or not data should be read into the buffer from the database, or written from the buffer to the DB.

Parameters:

forRead - The new read flag

getSize

public abstract long getSize()

Gets the buffer size.

Returns:

The buffer size.

getInputStream

public abstract InputStream getInputStream()
                                    throws IOException

Gets an InputStream to read buffer information.

Returns:

An InputStream object.

Throws:

IOException

getOutputStream

public abstract OutputStream getOutputStream()
                                      throws IOException

Gets an OutputStream to write buffer information.

Returns:

An OutputStream object.

Throws:

IOException

toString

public String toString()

Gets a string representation of this byte buffer.

Overrides:

toString in class Object

Returns:

A String representing this object.