Package org.eclipse.keypop.storagecard.card

Interface StorageCardSelectionExtension

All Superinterfaces:

org.eclipse.keypop.reader.selection.spi.CardSelectionExtension

public interface StorageCardSelectionExtension
extends org.eclipse.keypop.reader.selection.spi.CardSelectionExtension

Extends the CardSelectionExtension interface of the "Keypop Reader API" to provide means to define optional commands to be executed during the selection phase.

Since:

1.0.0

Method Summary

Modifier and Type	Method	Description
StorageCardSelectionExtension	prepareReadBlock(int blockNumber)	Prepares the reading of a specific block from the storage card.
StorageCardSelectionExtension	prepareReadBlocks(int fromBlockNumber, int toBlockNumber)	Prepares the reading of a range of blocks from the storage card.

Method Details

prepareReadBlock

StorageCardSelectionExtension prepareReadBlock(int blockNumber)

Prepares the reading of a specific block from the storage card.

Block numbers start at 0 and the maximum value is provided by ProductType.getBlockCount().

Once this command is processed, the result is available in StorageCard.

Parameters:

blockNumber - The number of the block to be read.

Returns:

The current instance.

Throws:

IllegalArgumentException - If the block number is out of range.

Since:

1.0.0

See Also:

• ProductType.getBlockCount()

prepareReadBlocks

StorageCardSelectionExtension prepareReadBlocks(int fromBlockNumber,
 int toBlockNumber)

Prepares the reading of a range of blocks from the storage card.

Block numbers start at 0 and the maximum value is provided by ProductType.getBlockCount().

Once this command is processed, the result is available in StorageCard.

Parameters:

fromBlockNumber - The starting block number (inclusive).

toBlockNumber - The ending block number (inclusive).

Returns:

The current instance.

Throws:

IllegalArgumentException - If one of the arguments is out of range.

Since:

1.0.0

See Also:

• ProductType.getBlockCount()