1 /* IIOServiceProvider.java -- General service provider for image I/O. 2 Copyright (C) 2004, 2005 Free Software Foundation, Inc. 3 4 This file is part of GNU Classpath. 5 6 GNU Classpath is free software; you can redistribute it and/or modify 7 it under the terms of the GNU General Public License as published by 8 the Free Software Foundation; either version 2, or (at your option) 9 any later version. 10 11 GNU Classpath is distributed in the hope that it will be useful, but 12 WITHOUT ANY WARRANTY; without even the implied warranty of 13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 14 General Public License for more details. 15 16 You should have received a copy of the GNU General Public License 17 along with GNU Classpath; see the file COPYING. If not, write to the 18 Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 19 02110-1301 USA. 20 21 Linking this library statically or dynamically with other modules is 22 making a combined work based on this library. Thus, the terms and 23 conditions of the GNU General Public License cover the whole 24 combination. 25 26 As a special exception, the copyright holders of this library give you 27 permission to link this library with independent modules to produce an 28 executable, regardless of the license terms of these independent 29 modules, and to copy and distribute the resulting executable under 30 terms of your choice, provided that you also meet, for each linked 31 independent module, the terms and conditions of the license of that 32 module. An independent module is a module which is not derived from 33 or based on this library. If you modify this library, you may extend 34 this exception to your version of the library, but you are not 35 obligated to do so. If you do not wish to do so, delete this 36 exception statement from your version. */ 37 38 39 package javax.imageio.spi; 40 41 import java.util.Locale; 42 43 44 /** 45 * An abstract superclass for service providers that perform image I/O. 46 * 47 * @since 1.4 48 * 49 * @author Sascha Brawer (brawer@dandelis.ch) 50 */ 51 public abstract class IIOServiceProvider 52 implements RegisterableService 53 { 54 /** 55 * The vendor of this service provider, or <code>null</code> if the 56 * subclass constructor did not set this field. 57 * 58 * @see #getVendorName() 59 */ 60 protected String vendorName; 61 62 63 /** 64 * The version of this service provider, or <code>null</code> if the 65 * subclass constructor did not set this field. 66 * 67 * @see #getVersion() 68 */ 69 protected String version; 70 71 72 /** 73 * Constructs a general <code>IIOServiceProvider</code>, given the 74 * vendor name and a version string. 75 * 76 * @throws IllegalArgumentException if <code>vendorName</code> 77 * or <code>version</code> is <code>null</code>. 78 */ IIOServiceProvider(String vendorName, String version)79 public IIOServiceProvider(String vendorName, String version) 80 { 81 if (vendorName == null || version == null) 82 throw new IllegalArgumentException(); 83 84 this.vendorName = vendorName; 85 this.version = version; 86 } 87 88 89 /** 90 * Constructs a general <code>IIOServiceProvider</code> without 91 * specifying a vendor name and a version string. The subclass 92 * constructor should set the {@link #vendorName} and {@link 93 * #version} to non-null values. 94 */ IIOServiceProvider()95 public IIOServiceProvider() 96 { 97 } 98 99 100 /** 101 * Informs this service provider that it has been registered in a 102 * {@link ServiceRegistry}. If this provider gets registered as an 103 * implementor for several service categories, its 104 * <code>onRegistration</code> method will be called multiple times. 105 * The default implementation does nothing. 106 * 107 * @param registry the registry to which this service provider has 108 * been added. 109 * 110 * @param category the service category for which this provider has 111 * been registered as an implementor. 112 */ onRegistration(ServiceRegistry registry, Class<?> category)113 public void onRegistration(ServiceRegistry registry, Class<?> category) 114 { 115 } 116 117 118 /** 119 * Informs this service provider that it has been de-registered from 120 * a {@link ServiceRegistry}. If this provider had been registered 121 * as an implementor for several service categories, its 122 * <code>onDeregistration</code> method will be called multiple 123 * times. The default implementation does nothing. 124 * 125 * @param registry the registry from which this service provider has 126 * been removed. 127 * 128 * @param category the service category for which this provider has 129 * been registered as an implementor. 130 */ onDeregistration(ServiceRegistry registry, Class<?> category)131 public void onDeregistration(ServiceRegistry registry, Class<?> category) 132 { 133 } 134 135 136 /** 137 * Returns the name of the vendor of this service provider. 138 */ getVendorName()139 public String getVendorName() 140 { 141 return vendorName; 142 } 143 144 145 /** 146 * Returns an identifier string for the version of this service 147 * provider. 148 */ getVersion()149 public String getVersion() 150 { 151 return version; 152 } 153 154 155 /** 156 * Returns a short description of this service provider that can be 157 * presented to a human user. 158 * 159 * @param locale the locale for which the description string should 160 * be localized. 161 */ getDescription(Locale locale)162 public abstract String getDescription(Locale locale); 163 } 164