org.jscsi.target.scsi.modeSense

Class ModePage

java.lang.Object

org.jscsi.target.scsi.modeSense.ModePage

All Implemented Interfaces:

ISerializable

Direct Known Subclasses:

Page_0FormatModePage, SubPageFormatModePage

public abstract class ModePage
extends Object
implements ISerializable

MODE PAGEs are sent in response to successful MODE SENSE SCSI commands. There are two different, command-specific formats for MODE PAGEs - the PAGE_0 FORMAT and the SUB-PAGE FORMAT, represented by the non-abstract children of this class, Page_0FormatModePage and SubPageFormatModePage, respectively.

Author:

Andreas Ergenzinger

Field Summary

Fields

Modifier and Type	Field and Description
protected int	pageLength The number of bytes following the PAGE LENGTH field.

Constructor Summary

Constructors

Constructor and Description
ModePage(boolean parametersSaveable, boolean subPageFormat, int pageCode, int pageLength) The abstract constructor.

Method Summary

Methods

Modifier and Type	Method and Description
void	serialize(ByteBuffer byteBuffer, int index) Inserts a serialized representation of the object into the specified ByteBuffer.
protected abstract void	serializeModeParameters(ByteBuffer buffer, int index)
protected abstract void	serializePageLength(ByteBuffer buffer, int index) Serializes the PAGE LENGTH field.
protected abstract void	serializeSubPageCode(ByteBuffer buffer, int index) This method serializes the SUBPAGE CODE field, if the mode page format says this field exists (only for the sub_page mode page format).
int	size() Returns the size in bytes of the object's serialized representation.

Methods inherited from class java.lang.Object

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

Field Detail

pageLength

protected final int pageLength

The number of bytes following the PAGE LENGTH field.

Constructor Detail

ModePage

public ModePage(boolean parametersSaveable,
        boolean subPageFormat,
        int pageCode,
        int pageLength)

The abstract constructor.

Parameters:

parametersSaveable - value of the PARAMETERS SAVEABLE bit

subPageFormat - true if and only if the SUB-PAGE FORMAT is to be used

pageCode - specifies the kind of information is contained in the MODE PAGE

pageLength - the value of the PAGE LENGTH field

Method Detail

serialize

public final void serialize(ByteBuffer byteBuffer,
             int index)

Description copied from interface: ISerializable

Inserts a serialized representation of the object into the specified ByteBuffer. The serialized object will occupy the byte positions from index to index + ISerializable.size() - 1.

Specified by:

serialize in interface ISerializable

Parameters:

byteBuffer - where to insert the serialized object representation

index - the position of the first byte of the serialized object in the ByteBuffer

serializeSubPageCode

protected abstract void serializeSubPageCode(ByteBuffer buffer,
                        int index)

This method serializes the SUBPAGE CODE field, if the mode page format says this field exists (only for the sub_page mode page format).

Parameters:

buffer - where to insert the serialized object representation

index - the position of the first byte of the serialized object in the ByteBuffer

serializePageLength

protected abstract void serializePageLength(ByteBuffer buffer,
                       int index)

Serializes the PAGE LENGTH field.

Parameters:

buffer - where to insert the serialized object representation

index - the position of the first byte of the serialized object in the ByteBuffer

serializeModeParameters

protected abstract void serializeModeParameters(ByteBuffer buffer,
                           int index)

Parameters:

buffer - where to insert the serialized object representation

index - the position of the first byte of the serialized object in the ByteBuffer

size

public final int size()

Description copied from interface: ISerializable

Returns the size in bytes of the object's serialized representation.

Specified by:

size in interface ISerializable

Returns:

the size in bytes of the object's serialized representation