incubator-kato-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From spo...@apache.org
Subject svn commit: r800529 - /incubator/kato/trunk/org.apache.kato/kato.api/src/main/java/javax/tools/diagnostics/FactoryRegistry.java
Date Mon, 03 Aug 2009 20:24:47 GMT
Author: spoole
Date: Mon Aug  3 20:24:47 2009
New Revision: 800529

URL: http://svn.apache.org/viewvc?rev=800529&view=rev
Log:
updated Factory Registry javadoc

Modified:
    incubator/kato/trunk/org.apache.kato/kato.api/src/main/java/javax/tools/diagnostics/FactoryRegistry.java

Modified: incubator/kato/trunk/org.apache.kato/kato.api/src/main/java/javax/tools/diagnostics/FactoryRegistry.java
URL: http://svn.apache.org/viewvc/incubator/kato/trunk/org.apache.kato/kato.api/src/main/java/javax/tools/diagnostics/FactoryRegistry.java?rev=800529&r1=800528&r2=800529&view=diff
==============================================================================
--- incubator/kato/trunk/org.apache.kato/kato.api/src/main/java/javax/tools/diagnostics/FactoryRegistry.java
(original)
+++ incubator/kato/trunk/org.apache.kato/kato.api/src/main/java/javax/tools/diagnostics/FactoryRegistry.java
Mon Aug  3 20:24:47 2009
@@ -25,15 +25,16 @@
 
 
 /**
+ * <p>
  * Experimental addition to the API.
- * 
+ * <p>
  * This class provides a central registry for image factories
- * 
+ * <p>
  * Image factories can be registered directly using the {@link #addFactory()} method.
- * 
- * The default registry uses {@link  javax.imageio.spi.ServiceRegistry} to discover
+ * <p>
+ * The default registry obtained by calling {@link #getDefaultRegistry()} uses {@link  javax.imageio.spi.ServiceRegistry}
to discover
  * ImageFactory implementations.
- * 
+ * <p>
  * To register an ImageFactory implementation that can be discovered by the registry do the
  * following :
  * <ul> 
@@ -42,7 +43,7 @@
  * <li>This text file should contain a single line which is the package qualified name
of the ImageFactory 
  * implementation to be registered
  * </ul>  
- * 
+ * </p>
  * @experimental
  *
  */
@@ -51,11 +52,16 @@
 	private static FactoryRegistry defaultRegistry=null;
 	private Set<ImageFactory> factories=new HashSet<ImageFactory>();
 	
+	/**
+	 * <p>
+	 * Creates an empty registry.  To obtain an populated registry use the {@link #getDefaultRegistry()}
method
+	 */
 	public FactoryRegistry() {
 		
 	}
 	
 	/**
+	 * <p>
 	 * Returns the default registry.  This registy is preloaded with
 	 * ImageFactory implementations discovered using the {@link  javax.imageio.spi.ServiceRegistry}

 	 * 
@@ -75,6 +81,7 @@
 
 	
 	/**
+	 * <p>
 	 * Using {@link  javax.imageio.spi.ServiceRegistry} this method
 	 * finds ImageFactory implementations and adds them to this instance
 	 */
@@ -92,7 +99,8 @@
 	}
 
 	/**
-	 * Returns an Iterator of ImageFactories registered
+	 * <p>
+	 * Returns an {@link java.util.Iterator} of ImageFactories registered
 	 * to this registry. 
 	 */
 	public Iterator<ImageFactory> iterator() {
@@ -100,11 +108,12 @@
 	}
 
 	/**
+	 * <p>
 	 * Adds an ImageFactory to the registry instance
 	 * If the factory instance is already in the 
 	 * registry it is not added again.
 	 *  
-	 * @param factory
+	 * @param factory factory to add to registry
 	 * @throws IllegalArgument if factory is null
 	 * @return true if factory added 
 	 */
@@ -115,10 +124,11 @@
 	}
 
 	/**
-	 * Returns the factories in the registry as an array
-	 * 
+	 * <p>
 	 * Always returns an array even if the registry is empty
 	 * 
+	 * @return Returns the factories in the registry as an array
+	 * 
 	 */
 	public ImageFactory[] getFactories() {
 		
@@ -126,11 +136,12 @@
 	}
 	
 	/**
+	 * <p>
 	 * Returns an appropriate {@link javax.tools.diagnostics.image.Image} for the
 	 * provide file by locating the first registered image factory that can handle
 	 * the case insensitive file name extension of the provided file. 
 	 * If no factory can be found to handle the file then null is returned. 
-	 * 
+	 * <p>
 	 * File names without extension will always return null  
 	 *  
 	 * @throws IllegalArgumentException if file is null



Mime
View raw message