org.eclipse.keyple.core.card.selection

Class CardSelectionsResult

java.lang.Object

org.eclipse.keyple.core.card.selection.CardSelectionsResult

public final class CardSelectionsResult
extends java.lang.Object

Contains the result of a selection process.

Embeds a map of AbstractSmartCard. At most one of these matching card is active.
Provides a set of methods to retrieve the active selection (getActiveSmartCard) or a particular matching card specified by its index.

Since:

0.9

Method Summary

Modifier and Type	Method and Description
int	getActiveSelectionIndex() Gets the index of the active selection
AbstractSmartCard	getActiveSmartCard() Get the active matching card.
AbstractSmartCard	getSmartCard(int selectionIndex) Gets the AbstractSmartCard for the specified index.
java.util.Map<java.lang.Integer,AbstractSmartCard>	getSmartCards() Gets all the AbstractSmartCard corresponding to all selection cases in a map where the key is the selection index.
boolean	hasActiveSelection() Tells if the current selection process resulted in an active selection.
boolean	hasSelectionMatched(int selectionIndex) Get the matching status of a selection case for which the index is provided.

Methods inherited from class java.lang.Object

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

Method Detail

getActiveSmartCard

public AbstractSmartCard getActiveSmartCard()

Get the active matching card. I.e. the card that has been selected.
The hasActiveSelection method should be called before.

Returns:

the currently active matching card

Throws:

java.lang.IllegalStateException - if no active matching card is found

Since:

0.9

getSmartCards

public java.util.Map<java.lang.Integer,AbstractSmartCard> getSmartCards()

Gets all the AbstractSmartCard corresponding to all selection cases in a map where the key is the selection index.

Returns:

A map

Since:

0.9

getSmartCard

public AbstractSmartCard getSmartCard(int selectionIndex)

Gets the AbstractSmartCard for the specified index.

Returns null if no AbstractSmartCard was found.

Parameters:

selectionIndex - the selection index

Returns:

the AbstractSmartCard or null

Since:

0.9

hasActiveSelection

public boolean hasActiveSelection()

Tells if the current selection process resulted in an active selection.

Returns:

true if an active selection is present

Since:

0.9

hasSelectionMatched

public boolean hasSelectionMatched(int selectionIndex)

Get the matching status of a selection case for which the index is provided.
Checks for the presence of an entry in the AbstractSmartCard Map for the given index

Parameters:

selectionIndex - the selection index

Returns:

true if the selection has matched

Since:

0.9

getActiveSelectionIndex

public int getActiveSelectionIndex()

Gets the index of the active selection

Returns:

the index as an int

Throws:

java.lang.IllegalStateException - if there is no active selection

Since:

0.9