1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155
/* * @(#)IIOServiceProvider.java 1.19 05/11/17 * * Copyright 2006 Sun Microsystems, Inc. All rights reserved. * SUN PROPRIETARY/CONFIDENTIAL. Use is subject to license terms. */ package javax.imageio.spi; import java.util.Locale; import javax.imageio.spi.RegisterableService; import javax.imageio.spi.ServiceRegistry; /** * 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 * @see javax.imageio.spi.ImageInputStreamSpi * * @version 0.5 */ 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!"); } if (version == null) { throw new IllegalArgumentException("version == null!"); } 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. * * <p> Only the registry should call this method. * * <p> The default implementation does nothing. * * @see ServiceRegistry#registerServiceProvider(Object provider) */ 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. * * @see ServiceRegistry#deregisterServiceProvider(Object provider) */ public void onDeregistration(ServiceRegistry registry, Class<?> category) {} /** * 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. * * <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; } /** * 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. * * <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); }