org.jscsi.target.scsi.sense.senseDataDescriptor

Class SenseDataDescriptor

java.lang.Object

org.jscsi.target.scsi.sense.senseDataDescriptor.SenseDataDescriptor

All Implemented Interfaces:

ISerializable

Direct Known Subclasses:

CommandSpecificSenseDataDescriptor, InformationSenseDataDescriptor, SenseKeySpecificSenseDataDescriptor

public abstract class SenseDataDescriptor
extends Object
implements ISerializable

Sense data descriptors are part of sense data and provide specific sense information. A given type of sense data descriptor shall be included in the sense data only when the information it contains is valid.

Author:

Andreas Ergenzinger

Constructor Summary

Constructors

Constructor and Description
SenseDataDescriptor(SenseDataDescriptorType descriptorType, int additionalLength) 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	serializeSpecificFields(ByteBuffer byteBuffer, int index) Serializes all fields which are not common to all sense data descriptors, which means those that are sub-type-specific.
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

Constructor Detail

SenseDataDescriptor

public SenseDataDescriptor(SenseDataDescriptorType descriptorType,
                   int additionalLength)

The abstract constructor.

Parameters:

descriptorType - determines the specific type of the sense data descriptor

additionalLength - the length in bytes of all additional fields

See Also:

COMMON_FIELDS_LENGTH

Method Detail

serializeSpecificFields

protected abstract void serializeSpecificFields(ByteBuffer byteBuffer,
                           int index)

Serializes all fields which are not common to all sense data descriptors, which means those that are sub-type-specific.

Parameters:

byteBuffer - where the serialized fields will be stored

index - the position of the first byte of the sense data descriptor in the ByteBuffer

serialize

public 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

size

public 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