javax.imageio.spi

Класс ServiceRegistry

java.lang. Объект

javax.imageio.spi. ServiceRegistry

Прямые Известные Подклассы:

IIORegistry

public class ServiceRegistry
extends Object

Реестр для экземпляров поставщика услуг.

Служба является известным набором интерфейсов и (обычно краткий обзор) классы. Поставщик услуг является определенной реализацией службы. Классы в провайдере обычно реализуют интерфейс или разделяют на подклассы класс, определенный службой непосредственно.

Поставщики услуг сохранены в одной или более категориях, каждая из которых определяется классом интерфейса (описанный a Class объект), который должны реализовать все его элементы. Набор категорий может быть изменен динамически.

Только единственный экземпляр данного листового класса (то есть, фактический класс, возвращенный getClass(), в противоположность любым наследованным классам или интерфейсам), может быть зарегистрирован. Таким образом, предположите что com.mycompany.mypkg.GreenServiceProvider класс реализует com.mycompany.mypkg.MyService интерфейс. Если a GreenServiceProvider экземпляр регистрируется, он будет сохранен в категории, определенной MyService класс. Если новый экземпляр GreenServiceProvider регистрируется, это заменит предыдущий экземпляр. Практически, объекты поставщика услуг обычно являются одиночными элементами, таким образом, это поведение является соответствующим.

Объявить поставщика услуг, a services подкаталог помещается в пределах META-INF каталог, который присутствует в каждом файле JAR. Этот каталог содержит файл для каждого интерфейса поставщика услуг, у которого есть один или более классов реализации, существующих в файле JAR. Например, если файл JAR, содержавший класс, называют com.mycompany.mypkg.MyServiceImpl который реализует javax.someapi.SomeService интерфейс, файл JAR содержал бы названный файл:

 META-INF/services/javax.someapi.SomeService 

содержа строку:

 com.mycompany.mypkg.MyService
 

Классы поставщика услуг должны быть должны быть легкими и быстрыми, чтобы загрузиться. Реализации этих интерфейсов должны избежать сложных зависимостей от других классов и от собственного кода. Обычный образец для более сложных служб должен зарегистрировать легкий прокси для тяжелой службы.

Приложение может настроить содержание реестра, как оно считает целесообразным, пока у него есть соответствующее разрешение времени выполнения.

Для получения дополнительной информации при объявлении поставщиков услуг, и формата JAR вообще, см. Спецификацию Файла JAR.

См. Также:

RegisterableService

Вложенная Сводка Класса

Вложенные Классы

Модификатор и Тип	Класс и Описание
static interface	ServiceRegistry. Фильтр Простой интерфейс фильтра, используемый ServiceRegistry.getServiceProviders выбрать провайдеров, соответствующих произвольный критерий.

Сводка конструктора

Конструкторы

Конструктор и Описание
ServiceRegistry(Iterator<Class<?>> categories) Конструкции a ServiceRegistry экземпляр с рядом категорий, взятых от categories параметр.

Сводка метода

Методы

Модификатор и Тип	Метод и Описание
boolean	contains(Object provider) Возвраты true если provider в настоящий момент регистрируется.
void	deregisterAll() Вычеркивает из списка всех в настоящий момент зарегистрированных поставщиков услуг от всех категорий.
void	deregisterAll(Class<?> category) Вычеркивает из списка весь объект поставщика услуг, в настоящий момент зарегистрированный под данной категорией.
void	deregisterServiceProvider(Object provider) Удаляет объект поставщика услуг из всех категорий, которые содержат его.
<T> boolean	deregisterServiceProvider(T provider, Class<T> category) Удаляет объект поставщика услуг из данной категории.
void	finalize() Завершает этот объект до сборки "мусора".
Iterator<Class<?>>	getCategories() Возвраты Iterator из Class объекты, указывающие на текущий набор категорий.
<T> T	getServiceProviderByClass(Class<T> providerClass) Возвращает в настоящий момент зарегистрированный объект поставщика услуг, который имеет данный тип класса.
<T> Iterator<T>	getServiceProviders(Class<T> category, boolean useOrdering) Возвраты Iterator содержа всех зарегистрированных поставщиков услуг в данной категории.
<T> Iterator<T>	getServiceProviders(Class<T> category, ServiceRegistry.Filter filter, boolean useOrdering) Возвраты Iterator содержа поставщика услуг возражает в пределах данной категории, которые удовлетворяют критерий, наложенный предоставленным ServiceRegistry.Filter объект filter метод.
static <T> Iterator<T>	lookupProviders(Class<T> providerClass) Определяет местоположение и с приращением инстанцирует доступных провайдеров данной службы, используя загрузчик класса контекста.
static <T> Iterator<T>	lookupProviders(Class<T> providerClass, ClassLoader loader) Поиски реализаций определенного класса службы, используя данный загрузчик класса.
void	registerServiceProvider(Object provider) Добавляет объект поставщика услуг к реестру.
<T> boolean	registerServiceProvider(T provider, Class<T> category) Добавляет объект поставщика услуг к реестру.
void	registerServiceProviders(Iterator<?> providers) Добавляет ряд объектов поставщика услуг, взятых от Iterator к реестру.
<T> boolean	setOrdering(Class<T> category, T firstProvider, T secondProvider) Устанавливает попарное упорядочивание между двумя объектами поставщика услуг в пределах данной категории.
<T> boolean	unsetOrdering(Class<T> category, T firstProvider, T secondProvider) Устанавливает попарное упорядочивание между двумя объектами поставщика услуг в пределах данной категории.

Методы java.lang унаследованный от класса. Объект

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

Деталь конструктора

ServiceRegistry

public ServiceRegistry(Iterator<Class<?>> categories)

Конструкции a ServiceRegistry экземпляр с рядом категорий, взятых от categories параметр.

Параметры:

categories - Iterator содержа Class объекты, которые будут использоваться, чтобы определить категории.

Броски:

IllegalArgumentException - если categories null.

Деталь метода

lookupProviders

public static <T> Iterator<T> lookupProviders(Class<T> providerClass,
                              ClassLoader loader)

Поиски реализаций определенного класса службы, используя данный загрузчик класса.

Этот метод преобразовывает имя данного класса службы в имя файла конфигурации провайдера как описано в комментарии класса и затем использует getResources метод данного загрузчика класса, чтобы найти все доступные файлы с тем именем. Эти файлы тогда читаются и анализируются, чтобы произвести список имен классов провайдера. iterator, который возвращается, использует данный загрузчик класса, чтобы искать и затем инстанцировать каждого элемента списка.

Поскольку для расширений возможно быть установленным в рабочую виртуальную машину Java, этот метод может возвратить различные результаты каждый раз, когда это вызывается.

Параметры:

providerClass - a Classобъект, указывающий на класс или интерфейс обнаруживаемых поставщиков услуг.

loader - загрузчик класса, который будет использоваться, чтобы загрузить конфигурационные файлы провайдера и инстанцировать классов провайдера, или null если системный загрузчик класса (или, приводя к сбою, что загрузчик класса начальной загрузки) должен использоваться.

Возвраты:

Iterator это приводит к объектам провайдера для данной службы в некотором произвольном порядке. iterator бросит Error если конфигурационный файл провайдера нарушает указанный формат или если класс провайдера не может быть найден и инстанцирован.

Броски:

IllegalArgumentException - если providerClass null.

lookupProviders

public static <T> Iterator<T> lookupProviders(Class<T> providerClass)

Определяет местоположение и с приращением инстанцирует доступных провайдеров данной службы, используя загрузчик класса контекста. Этот метод удобства эквивалентен:

   ClassLoader cl = Thread.currentThread().getContextClassLoader();
   return Service.providers(service, cl);
 

Параметры:

providerClass - a Classобъект, указывающий на класс или интерфейс обнаруживаемых поставщиков услуг.

Возвраты:

Iterator это приводит к объектам провайдера для данной службы в некотором произвольном порядке. iterator бросит Error если конфигурационный файл провайдера нарушает указанный формат или если класс провайдера не может быть найден и инстанцирован.

Броски:

IllegalArgumentException - если providerClass null.

getCategories

public Iterator<Class<?>> getCategories()

Возвраты Iterator из Class объекты, указывающие на текущий набор категорий. iterator будет пуст, если никакие категории не будут существовать.

Возвраты:

Iterator содержа Classобъекты.

registerServiceProvider

public <T> boolean registerServiceProvider(T provider,
                                  Class<T> category)

Добавляет объект поставщика услуг к реестру. Провайдер связывается с данной категорией.

Если provider реализации RegisterableService интерфейс, onRegistration метод вызовут. onDeregistration метод вызовут каждый раз, когда он вычеркивается из списка от категории, например если категория удаляется, или реестр собирается "мусор".

Параметры:

provider - служба обеспечивает объект, который будет зарегистрирован.

category - категория, под которой можно зарегистрировать провайдера.

Возвраты:

истина, если никакой провайдер того же самого класса не был ранее зарегистрирован в той же самой категории категории.

Броски:

IllegalArgumentException - если provider null.

IllegalArgumentException - если нет никакого соответствия категории category.

ClassCastException - если провайдер не реализует Class определенный category.

registerServiceProvider

public void registerServiceProvider(Object provider)

Добавляет объект поставщика услуг к реестру. Провайдер связывается в пределах каждой категории, существующей в реестре чей Class это реализует.

Если provider реализации RegisterableService интерфейс, onRegistration однажды метод вызовут для каждой категории, под которой он регистрируется. onDeregistration метод вызовут каждый раз, когда он вычеркивается из списка от категории или когда реестр завершается.

Параметры:

provider - объект поставщика услуг, который будет зарегистрирован.

Броски:

IllegalArgumentException - если provider null.

registerServiceProviders

public void registerServiceProviders(Iterator<?> providers)

Добавляет ряд объектов поставщика услуг, взятых от Iterator к реестру. Каждый провайдер связывается в пределах каждой категории, существующей в реестре чей Class это реализует.

Для каждой записи providers это реализует RegisterableService интерфейс, onRegistration однажды метод вызовут для каждой категории, под которой он регистрируется. onDeregistration метод вызовут каждый раз, когда он вычеркивается из списка от категории или когда реестр завершается.

Параметры:

providers - Iterator, содержащий поставщика услуг, возражает, чтобы быть зарегистрированным.

Броски:

IllegalArgumentException - если providers null или содержит a null запись.

deregisterServiceProvider

public <T> boolean deregisterServiceProvider(T provider,
                                    Class<T> category)

Удаляет объект поставщика услуг из данной категории. Если провайдер не был ранее зарегистрирован, ничто не происходит и false возвращается. Иначе, true возвращается. Если объект того же самого класса как provider но не равный (использование ==) к provider регистрируется, это не будет вычеркнуто из списка.

Если provider реализации RegisterableService интерфейс, onDeregistration метод вызовут.

Параметры:

provider - объект поставщика услуг, который будет вычеркнут из списка.

category - категория, от которой можно вычеркнуть из списка провайдера.

Возвраты:

true если провайдер был ранее зарегистрирован в той же самой категории категории, false иначе.

Броски:

IllegalArgumentException - если provider null.

IllegalArgumentException - если нет никакого соответствия категории category.

ClassCastException - если провайдер не реализует класс, определенный category.

deregisterServiceProvider

public void deregisterServiceProvider(Object provider)

Удаляет объект поставщика услуг из всех категорий, которые содержат его.

Параметры:

provider - объект поставщика услуг, который будет вычеркнут из списка.

Броски:

IllegalArgumentException - если provider null.

содержит

public boolean contains(Object provider)

Возвраты true если provider в настоящий момент регистрируется.

Параметры:

provider - объект поставщика услуг, который будет запрошен.

Возвраты:

true если данный провайдер был зарегистрирован.

Броски:

IllegalArgumentException - если provider null.

getServiceProviders

public <T> Iterator<T> getServiceProviders(Class<T> category,
                                  boolean useOrdering)

Возвраты Iterator содержа всех зарегистрированных поставщиков услуг в данной категории. Если useOrdering false, iterator возвратит все объекты провайдера сервера в произвольном порядке. Иначе, упорядочивание будет уважать любые попарные упорядочивания, которые были установлены. Если график попарных упорядочиваний будет содержать циклы, то любые провайдеры, которые принадлежат циклу, не будут возвращены.

Параметры:

category - категория, которая будет получена от.

useOrdering - true если попарные упорядочивания должны быть приняты во внимание в упорядочивании возвращенных объектов.

Возвраты:

Iterator содержа поставщика услуг возражает от данной категории, возможно в порядке.

Броски:

IllegalArgumentException - если нет никакого соответствия категории category.

getServiceProviders

public <T> Iterator<T> getServiceProviders(Class<T> category,
                                  ServiceRegistry.Filter filter,
                                  boolean useOrdering)

Возвраты Iterator содержа поставщика услуг возражает в пределах данной категории, которые удовлетворяют критерий, наложенный предоставленным ServiceRegistry.Filter объект filter метод.

useOrdering параметр управляет упорядочиванием результатов, используя те же самые правила как getServiceProviders(Class, boolean).

Параметры:

category - категория, которая будет получена от.

filter - экземпляр ServiceRegistry.Filter чей filter метод будет вызван.

useOrdering - true если попарные упорядочивания должны быть приняты во внимание в упорядочивании возвращенных объектов.

Возвраты:

Iterator содержа поставщика услуг возражает от данной категории, возможно в порядке.

Броски:

IllegalArgumentException - если нет никакого соответствия категории category.

getServiceProviderByClass

public <T> T getServiceProviderByClass(Class<T> providerClass)

Возвращает в настоящий момент зарегистрированный объект поставщика услуг, который имеет данный тип класса. Самое большее одному объекту данного класса позволяют быть зарегистрированным в любой момент времени. Если ни у какого зарегистрированного объекта нет требуемого типа класса, null возвращается.

Параметры:

providerClass - Class из требуемого объекта поставщика услуг.

Возвраты:

в настоящий момент зарегистрированный поставщик услуг возражает с требуемым Classвведите, или null не ни один, присутствует.

Броски:

IllegalArgumentException - если providerClass null.

setOrdering

public <T> boolean setOrdering(Class<T> category,
                      T firstProvider,
                      T secondProvider)

Устанавливает попарное упорядочивание между двумя объектами поставщика услуг в пределах данной категории. Если один или оба объекта в настоящий момент не регистрируются в пределах данной категории, или если требуемое упорядочивание уже устанавливается, ничто не происходит и false возвращается. Если провайдеры ранее были упорядочены в обратном направлении, то упорядочивание удаляется.

Упорядочивание будет использоваться getServiceProviders методы, когда их useOrdering параметр true.

Параметры:

category - a Class объект, указывающий на категорию, под которой должно быть установлено предпочтение.

firstProvider - привилегированный провайдер.

secondProvider - провайдер тот, к который firstProvider предпочитается.

Возвраты:

true если ранее упорядочивание сброса было установлено.

Броски:

IllegalArgumentException - если любой провайдер null или они - тот же самый объект.

IllegalArgumentException - если нет никакого соответствия категории category.

unsetOrdering

public <T> boolean unsetOrdering(Class<T> category,
                        T firstProvider,
                        T secondProvider)

Устанавливает попарное упорядочивание между двумя объектами поставщика услуг в пределах данной категории. Если один или оба объекта в настоящий момент не регистрируются в пределах данной категории, или если никакое упорядочивание в настоящий момент не устанавливается между ними, ничто не происходит и false возвращается.

Упорядочивание будет использоваться getServiceProviders методы, когда их useOrdering параметр true.

Параметры:

category - a Class объект, указывающий на категорию, под которой должно быть отменено предпочтение.

firstProvider - прежде привилегированный провайдер.

secondProvider - провайдер тот, к который firstProvider был прежде предпочтен.

Возвраты:

true если ранее упорядочивание набора было отменено.

Броски:

IllegalArgumentException - если любой провайдер null или они - тот же самый объект.

IllegalArgumentException - если нет никакого соответствия категории category.

deregisterAll

public void deregisterAll(Class<?> category)

Вычеркивает из списка весь объект поставщика услуг, в настоящий момент зарегистрированный под данной категорией.

Параметры:

category - категория, которая будет освобождена.

Броски:

IllegalArgumentException - если нет никакого соответствия категории category.

deregisterAll

public void deregisterAll()

Вычеркивает из списка всех в настоящий момент зарегистрированных поставщиков услуг от всех категорий.

завершить

public void finalize()
              throws Throwable

Завершает этот объект до сборки "мусора". deregisterAll метод вызывают, чтобы вычеркнуть из списка всех в настоящий момент зарегистрированных поставщиков услуг. Этот метод нельзя вызвать от кода программы.

Переопределения:

finalize в классе Object

Броски:

Throwable - если ошибка происходит во время завершения суперкласса.