< prev index next >

src/java.desktop/share/classes/javax/imageio/spi/IIOServiceProvider.java

Print this page

        

*** 31,41 **** /** * 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 the ! * <code>IIORegistry</code> class. * * @see IIORegistry * @see javax.imageio.spi.ImageReaderSpi * @see javax.imageio.spi.ImageWriterSpi * @see javax.imageio.spi.ImageTranscoderSpi --- 31,41 ---- /** * 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 the ! * {@code IIORegistry} class. * * @see IIORegistry * @see javax.imageio.spi.ImageReaderSpi * @see javax.imageio.spi.ImageWriterSpi * @see javax.imageio.spi.ImageTranscoderSpi
*** 43,76 **** * @see javax.imageio.spi.ImageOutputStreamSpi */ public abstract class IIOServiceProvider implements RegisterableService { /** ! * A <code>String</code> to be returned from ! * <code>getVendorName</code>, initially <code>null</code>. ! * Constructors should set this to a non-<code>null</code> value. */ protected String vendorName; /** ! * A <code>String</code> to be returned from ! * <code>getVersion</code>, initially null. Constructors should ! * set this to a non-<code>null</code> value. */ protected String version; /** ! * Constructs an <code>IIOServiceProvider</code> with a given * vendor name and version identifier. * * @param vendorName the vendor name. * @param version a version identifier. * ! * @exception IllegalArgumentException if <code>vendorName</code> ! * is <code>null</code>. ! * @exception IllegalArgumentException if <code>version</code> ! * is <code>null</code>. */ public IIOServiceProvider(String vendorName, String version) { if (vendorName == null) { throw new IllegalArgumentException("vendorName == null!"); --- 43,76 ---- * @see javax.imageio.spi.ImageOutputStreamSpi */ public abstract class IIOServiceProvider implements RegisterableService { /** ! * A {@code String} to be returned from ! * {@code getVendorName}, initially {@code null}. ! * Constructors should set this to a non-{@code null} value. */ protected String vendorName; /** ! * A {@code String} to be returned from ! * {@code getVersion}, initially null. Constructors should ! * set this to a non-{@code null} value. */ protected String version; /** ! * Constructs an {@code IIOServiceProvider} with a given * vendor name and version identifier. * * @param vendorName the vendor name. * @param version a version identifier. * ! * @exception IllegalArgumentException if {@code vendorName} ! * is {@code null}. ! * @exception IllegalArgumentException if {@code version} ! * is {@code null}. */ public IIOServiceProvider(String vendorName, String version) { if (vendorName == null) { throw new IllegalArgumentException("vendorName == null!");
*** 81,103 **** this.vendorName = vendorName; this.version = version; } /** ! * Constructs a blank <code>IIOServiceProvider</code>. It is up * to the subclass to initialize instance variables and/or * override method implementations in order to ensure that the ! * <code>getVendorName</code> and <code>getVersion</code> methods ! * will return non-<code>null</code> values. */ public IIOServiceProvider() { } /** * A callback that will be called exactly once after the Spi class * has been instantiated and registered in a ! * <code>ServiceRegistry</code>. 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. * --- 81,103 ---- this.vendorName = vendorName; this.version = version; } /** ! * Constructs a blank {@code IIOServiceProvider}. It is up * to the subclass to initialize instance variables and/or * override method implementations in order to ensure that the ! * {@code getVendorName} and {@code getVersion} methods ! * will return non-{@code null} values. */ public IIOServiceProvider() { } /** * A callback that will be called exactly once after the Spi class * has been instantiated and registered in a ! * {@code ServiceRegistry}. 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. *
*** 110,120 **** public void onRegistration(ServiceRegistry registry, Class<?> category) {} /** * A callback that will be whenever the Spi class has been ! * deregistered from a <code>ServiceRegistry</code>. * * <p> Only the registry should call this method. * * <p> The default implementation does nothing. * --- 110,120 ---- public void onRegistration(ServiceRegistry registry, Class<?> category) {} /** * A callback that will be whenever the Spi class has been ! * deregistered from a {@code ServiceRegistry}. * * <p> Only the registry should call this method. * * <p> The default implementation does nothing. *
*** 128,140 **** * service provider and its associated implementation. Because * the vendor name may be used to select a service provider, * it is not localized. * * <p> The default implementation returns the value of the ! * <code>vendorName</code> instance variable. * ! * @return a non-<code>null</code> <code>String</code> containing * the name of the vendor. */ public String getVendorName() { return vendorName; } --- 128,140 ---- * service provider and its associated implementation. Because * the vendor name may be used to select a service provider, * it is not localized. * * <p> The default implementation returns the value of the ! * {@code vendorName} instance variable. * ! * @return a non-{@code null String} containing * the name of the vendor. */ public String getVendorName() { return vendorName; }
*** 145,172 **** * implementation. Because the version may be used by transcoders * to identify the service providers they understand, this method * is not localized. * * <p> The default implementation returns the value of the ! * <code>version</code> instance variable. * ! * @return a non-<code>null</code> <code>String</code> containing * the version of this service provider. */ public String getVersion() { return version; } /** * Returns a brief, human-readable description of this service * provider and its associated implementation. The resulting * string should be localized for the supplied ! * <code>Locale</code>, if possible. * ! * @param locale a <code>Locale</code> for which the return value * should be localized. * ! * @return a <code>String</code> containing a description of this * service provider. */ public abstract String getDescription(Locale locale); } --- 145,172 ---- * implementation. Because the version may be used by transcoders * to identify the service providers they understand, this method * is not localized. * * <p> The default implementation returns the value of the ! * {@code version} instance variable. * ! * @return a non-{@code null String} containing * the version of this service provider. */ public String getVersion() { return version; } /** * Returns a brief, human-readable description of this service * provider and its associated implementation. The resulting * string should be localized for the supplied ! * {@code Locale}, if possible. * ! * @param locale a {@code Locale} for which the return value * should be localized. * ! * @return a {@code String} containing a description of this * service provider. */ public abstract String getDescription(Locale locale); }
< prev index next >