This class is multi-threading safe and can be used by multiple threads concurrently. However, this object keeps track of the card presence state of each of its terminals. Multiple objects should be used if independent calls to waitForChange() are required.
Applications can obtain instances of this class by calling TerminalFactory.terminals().
- Since:
- 1.6
- See Also:
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic enum
Enumeration of attributes of a CardTerminal. -
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptiongetTerminal
(String name) Returns the terminal with the specified name or null if no such terminal exists.list()
Returns an unmodifiable list of all available terminals.abstract List
<CardTerminal> list
(CardTerminals.State state) Returns an unmodifiable list of all terminals matching the specified state.void
Waits for card insertion or removal in any of the terminals of this object.abstract boolean
waitForChange
(long timeout) Waits for card insertion or removal in any of the terminals of this object or until the timeout expires.
-
Constructor Details
-
CardTerminals
protected CardTerminals()Constructs a new CardTerminals object.This constructor is called by subclasses only. Application should call TerminalFactory.terminals() to obtain a CardTerminals object.
-
-
Method Details
-
list
Returns an unmodifiable list of all available terminals.- Returns:
- an unmodifiable list of all available terminals.
- Throws:
CardException
- if the card operation failed
-
list
Returns an unmodifiable list of all terminals matching the specified state.If state is
State.ALL
, this method returns all CardTerminals encapsulated by this object. If state isState.CARD_PRESENT
orState.CARD_ABSENT
, it returns all CardTerminals where a card is currently present or absent, respectively.If state is
State.CARD_INSERTION
orState.CARD_REMOVAL
, it returns all CardTerminals for which an insertion (or removal, respectively) was detected during the last call to waitForChange(). IfwaitForChange()
has not been called on this object,CARD_INSERTION
is equivalent toCARD_PRESENT
andCARD_REMOVAL
is equivalent toCARD_ABSENT
. For an example of the use ofCARD_INSERTION
, seewaitForChange()
.- Parameters:
state
- the State- Returns:
- an unmodifiable list of all terminals matching the specified state.
- Throws:
NullPointerException
- if state is nullCardException
- if the card operation failed
-
getTerminal
Returns the terminal with the specified name or null if no such terminal exists.- Parameters:
name
- the terminal name- Returns:
- the terminal with the specified name or null if no such terminal exists.
- Throws:
NullPointerException
- if name is null
-
waitForChange
Waits for card insertion or removal in any of the terminals of this object.This call is equivalent to calling waitForChange(0).
- Throws:
IllegalStateException
- if thisCardTerminals
object does not contain any terminalsCardException
- if the card operation failed
-
waitForChange
Waits for card insertion or removal in any of the terminals of this object or until the timeout expires.This method examines each CardTerminal of this object. If a card was inserted into or removed from a CardTerminal since the previous call to
waitForChange()
, it returns immediately. Otherwise, or if this is the first call towaitForChange()
on this object, it blocks until a card is inserted into or removed from a CardTerminal.If
timeout
is greater than 0, the method returns aftertimeout
milliseconds even if there is no change in state. In that case, this method returnsfalse
; otherwise it returnstrue
.This method is often used in a loop in combination with
list(State.CARD_INSERTION)
, for example:TerminalFactory factory = ...; CardTerminals terminals = factory.terminals(); while (true) { for (CardTerminal terminal : terminals.list(CARD_INSERTION)) { // examine Card in terminal, return if it matches } terminals.waitForChange(); }
- Parameters:
timeout
- if positive, block for up totimeout
milliseconds; if zero, block indefinitely; must not be negative- Returns:
- false if the method returns due to an expired timeout, true otherwise.
- Throws:
IllegalStateException
- if thisCardTerminals
object does not contain any terminalsIllegalArgumentException
- if timeout is negativeCardException
- if the card operation failed
-