Spec-Zone.ru › OpenJDK 17

Класс CardTerminals

java.lang.Object
javax.smartcardio.CardTerminals
public abstract class CardTerminals extends Object
Набор терминалов, поддерживаемых TerminalFactory. Этот класс позволяет приложениям перечислять доступные CardTerminals, получить определённый CardTerminal или ожидать вставки или извлечения карт.

Этот класс безопасен для многопоточных операций и может быть использован несколькими потоками одновременно. Однако этот объект отслеживает состояние наличия карты для каждого из своих терминалов. Несколько объектов должны быть использованы, если требуются независимые вызовы waitForChange().

Приложения могут получить экземпляры этого класса, вызвав TerminalFactory.terminals().

Since:
1.6
See Also:
  • TerminalFactory
  • CardTerminal

Краткое описание вложенных классов

Модификатор и тип Класс Описание
static enum  CardTerminals.State
Перечисление атрибутов CardTerminal.

Краткое описание конструкторов

CardTerminals()
Модификатор Конструктор Описание
protected
Создаёт новый объект CardTerminals.

Краткое описание методов

Модификатор и тип Метод Описание
CardTerminal getTerminal(String name)
Возвращает терминал с указанным именем или null, если такого терминала нет.
List<CardTerminal> list()
Возвращает неизменяемый список всех доступных терминалов.
abstract List<CardTerminal> list(CardTerminals.State state)
Возвращает неизменяемый список всех терминалов, соответствующих указанному состоянию.
void waitForChange()
Ожидает вставки или извлечения карты в любом из терминалов этого объекта.
abstract boolean waitForChange(long timeout)
Ожидает вставки или извлечения карты в любом из терминалов этого объекта или до истечения времени ожидания.

Методы, унаследованные от класса java.lang.Object

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

Подробное описание конструкторов

CardTerminals

protected CardTerminals()
Создаёт новый объект CardTerminals.

Этот конструктор вызывается только подклассами. Приложение должно вызвать TerminalFactory.terminals() для получения объекта CardTerminals.

Подробное описание методов

list

public List<CardTerminal> list() throws CardException
Возвращает неизменяемый список всех доступных терминалов.
Возвращает:
неизменяемый список всех доступных терминалов.
Исключения:
CardException - если операция с картой завершилась неудачно

list

public abstract List<CardTerminal> list(CardTerminals.State state) throws CardException
Возвращает неизменяемый список всех терминалов, соответствующих указанному состоянию.

Если состояние равно State.ALL, этот метод возвращает все CardTerminals, инкапсулированные этим объектом. Если состояние равно State.CARD_PRESENT или State.CARD_ABSENT, он возвращает все CardTerminals, где карта присутствует или отсутствует соответственно.

Если состояние равно State.CARD_INSERTION или State.CARD_REMOVAL, он возвращает все CardTerminals, для которых была обнаружена вставка (или удаление соответственно) во время последнего вызова waitForChange(). Если waitForChange() не был вызван для этого объекта, CARD_INSERTION эквивалентно CARD_PRESENT, и CARD_REMOVAL эквивалентно CARD_ABSENT. Пример использования CARD_INSERTION, см. waitForChange().

Параметры:
state - состояние
Возвращает:
неизменяемый список всех терминалов, соответствующих указанному состоянию.
Исключения:
NullPointerException - если состояние равно null
CardException - если операция с картой завершилась неудачно

getTerminal

public CardTerminal getTerminal(String name)
Возвращает терминал с указанным именем или null, если такого терминала нет.
Параметры:
name - имя терминала
Возвращает:
терминал с указанным именем или null, если такого терминала нет.
Исключения:
NullPointerException - если имя равно null

waitForChange

public void waitForChange() throws CardException
Ожидает вставки или извлечения карты в любом из терминалов этого объекта.

Этот вызов эквивалентен вызову waitForChange(0).

Исключения:
IllegalStateException - если этот CardTerminals объект не содержит терминалов
CardException - если операция с картой завершилась неудачно

waitForChange

public abstract boolean waitForChange(long timeout) throws CardException
Ожидает вставки или извлечения карты в любом из терминалов этого объекта или до истечения времени ожидания.

Этот метод проверяет каждый CardTerminal этого объекта. Если карта была вставлена или извлечена из CardTerminal с момента предыдущего вызова waitForChange(), он возвращается немедленно. В противном случае, или если это первый вызов waitForChange() для этого объекта, он блокируется до тех пор, пока карта не будет вставлена или извлечена из CardTerminal.

Если timeout больше 0, метод возвращается через timeout миллисекунд, даже если состояние не изменилось. В этом случае этот метод возвращает false; в противном случае он возвращает true.

Этот метод часто используется в цикле в сочетании с list(State.CARD_INSERTION), например:

  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();
  }
Параметры:
timeout - если положительное, блокировать до timeout миллисекунд; если ноль, блокировать неопределённо; не должно быть отрицательным
Возвращает:
false, если метод возвращается из-за истечения времени ожидания, true в противном случае.
Исключения:
IllegalStateException - если этот CardTerminals объект не содержит терминалов
IllegalArgumentException - если время ожидания отрицательное
CardException - если операция с картой завершилась неудачно

© 1993, 2021, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://docs.oracle.com/en/java/javase/17/docs/api/java.smartcardio/javax/smartcardio/CardTerminals.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API