- java.lang.Object
-
- javax.imageio.spi.IIOServiceProvider
-
- All Implemented Interfaces:
- RegisterableService
- Direct Known Subclasses:
- ImageInputStreamSpi, ImageOutputStreamSpi, ImageReaderWriterSpi, ImageTranscoderSpi
public abstract class IIOServiceProvider extends Object implements RegisterableService
A superinterface for functionality common to all Image I/O service provider interfaces (SPIs). For more information on service provider classes, see the class comment for theIIORegistry
class.
-
-
Field Summary
Fields Modifier and Type Field and Description protected String
vendorName
AString
to be returned fromgetVendorName
, initiallynull
.protected String
version
AString
to be returned fromgetVersion
, initially null.
-
Constructor Summary
Constructors Constructor and Description IIOServiceProvider()
Constructs a blankIIOServiceProvider
.IIOServiceProvider(String vendorName, String version)
Constructs anIIOServiceProvider
with a given vendor name and version identifier.
-
Method Summary
Methods Modifier and Type Method and Description abstract String
getDescription(Locale locale)
Returns a brief, human-readable description of this service provider and its associated implementation.String
getVendorName()
Returns the name of the vendor responsible for creating this service provider and its associated implementation.String
getVersion()
Returns a string describing the version number of this service provider and its associated implementation.void
onDeregistration(ServiceRegistry registry, Class<?> category)
A callback that will be whenever the Spi class has been deregistered from aServiceRegistry
.void
onRegistration(ServiceRegistry registry, Class<?> category)
A callback that will be called exactly once after the Spi class has been instantiated and registered in aServiceRegistry
.
-
-
-
Field Detail
-
vendorName
protected String vendorName
AString
to be returned fromgetVendorName
, initiallynull
. Constructors should set this to a non-null
value.
-
version
protected String version
AString
to be returned fromgetVersion
, initially null. Constructors should set this to a non-null
value.
-
-
Constructor Detail
-
IIOServiceProvider
public IIOServiceProvider(String vendorName, String version)
Constructs anIIOServiceProvider
with a given vendor name and version identifier.- Parameters:
vendorName
- the vendor name.version
- a version identifier.- Throws:
IllegalArgumentException
- ifvendorName
isnull
.IllegalArgumentException
- ifversion
isnull
.
-
IIOServiceProvider
public IIOServiceProvider()
Constructs a blankIIOServiceProvider
. It is up to the subclass to initialize instance variables and/or override method implementations in order to ensure that thegetVendorName
andgetVersion
methods will return non-null
values.
-
-
Method Detail
-
onRegistration
public void onRegistration(ServiceRegistry registry, Class<?> category)
A callback that will be called exactly once after the Spi class has been instantiated and registered in aServiceRegistry
. This may be used to verify that the environment is suitable for this service, for example that native libraries can be loaded. If the service cannot function in the environment where it finds itself, it should deregister itself from the registry.Only the registry should call this method.
The default implementation does nothing.
- Specified by:
onRegistration
in interfaceRegisterableService
- Parameters:
registry
- aServiceRegistry
where this object has been registered.category
- aClass
object indicating the registry category under which this object has been registered.- See Also:
ServiceRegistry.registerServiceProvider(Object provider)
-
onDeregistration
public void onDeregistration(ServiceRegistry registry, Class<?> category)
A callback that will be whenever the Spi class has been deregistered from aServiceRegistry
.Only the registry should call this method.
The default implementation does nothing.
- Specified by:
onDeregistration
in interfaceRegisterableService
- Parameters:
registry
- aServiceRegistry
from which this object is being (wholly or partially) deregistered.category
- aClass
object indicating the registry category from which this object is being deregistered.- See Also:
ServiceRegistry.deregisterServiceProvider(Object provider)
-
getVendorName
public String getVendorName()
Returns the name of the vendor responsible for creating this service provider and its associated implementation. Because the vendor name may be used to select a service provider, it is not localized.The default implementation returns the value of the
vendorName
instance variable.- Returns:
- a non-
null
String
containing the name of the vendor.
-
getVersion
public String getVersion()
Returns a string describing the version number of this service provider and its associated implementation. Because the version may be used by transcoders to identify the service providers they understand, this method is not localized.The default implementation returns the value of the
version
instance variable.- Returns:
- a non-
null
String
containing the version of this service provider.
-
getDescription
public abstract String getDescription(Locale locale)
Returns a brief, human-readable description of this service provider and its associated implementation. The resulting string should be localized for the suppliedLocale
, if possible.- Parameters:
locale
- aLocale
for which the return value should be localized.- Returns:
- a
String
containing a description of this service provider.
-
-
Nederlandse vertaling
U hebt gevraagd om deze site in het Nederlands te bezoeken. Voor nu wordt alleen de interface vertaald, maar nog niet alle inhoud.Als je me wilt helpen met vertalingen, is je bijdrage welkom. Het enige dat u hoeft te doen, is u op de site registreren en mij een bericht sturen waarin u wordt gevraagd om u toe te voegen aan de groep vertalers, zodat u de gewenste pagina's kunt vertalen. Een link onderaan elke vertaalde pagina geeft aan dat u de vertaler bent en heeft een link naar uw profiel.
Bij voorbaat dank.
Document heeft de 11/06/2005 gemaakt, de laatste keer de 04/03/2020 gewijzigd
Bron van het afgedrukte document:https://www.gaudry.be/nl/java-api-rf-javax/imageio/spi/IIOServiceProvider.html
De infobrol is een persoonlijke site waarvan de inhoud uitsluitend mijn verantwoordelijkheid is. De tekst is beschikbaar onder CreativeCommons-licentie (BY-NC-SA). Meer info op de gebruiksvoorwaarden en de auteur.
Referenties
Deze verwijzingen en links verwijzen naar documenten die geraadpleegd zijn tijdens het schrijven van deze pagina, of die aanvullende informatie kunnen geven, maar de auteurs van deze bronnen kunnen niet verantwoordelijk worden gehouden voor de inhoud van deze pagina.
De auteur Deze site is als enige verantwoordelijk voor de manier waarop de verschillende concepten, en de vrijheden die met de referentiewerken worden genomen, hier worden gepresenteerd. Vergeet niet dat u meerdere broninformatie moet doorgeven om het risico op fouten te verkleinen.