myfaces-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From sless...@apache.org
Subject svn commit: r722682 - /myfaces/core/branches/2_0_0/api/src/main/java/javax/faces/FactoryFinder.java
Date Tue, 02 Dec 2008 23:55:33 GMT
Author: slessard
Date: Tue Dec  2 15:55:33 2008
New Revision: 722682

URL: http://svn.apache.org/viewvc?rev=722682&view=rev
Log:
MYFACES-2101 - Comment change on FactoryFinder.

Modified:
    myfaces/core/branches/2_0_0/api/src/main/java/javax/faces/FactoryFinder.java

Modified: myfaces/core/branches/2_0_0/api/src/main/java/javax/faces/FactoryFinder.java
URL: http://svn.apache.org/viewvc/myfaces/core/branches/2_0_0/api/src/main/java/javax/faces/FactoryFinder.java?rev=722682&r1=722681&r2=722682&view=diff
==============================================================================
--- myfaces/core/branches/2_0_0/api/src/main/java/javax/faces/FactoryFinder.java (original)
+++ myfaces/core/branches/2_0_0/api/src/main/java/javax/faces/FactoryFinder.java Tue Dec 
2 15:55:33 2008
@@ -86,6 +86,33 @@
   FactoryFinder() {
   }
 
+  /**
+   * <p>Create (if necessary) and return a per-web-application instance of the appropriate

+   * implementation class for the specified JavaServer Faces factory class, based on the

+   * discovery algorithm described in the class description.</p>
+   * 
+   * <p>The standard factories and wrappers in JSF all implement the interface {@link
FacesWrapper}. 
+   * If the returned <code>Object</code> is an implementation of one of the standard
factories, 
+   * it must be legal to cast it to an instance of <code>FacesWrapper</code>
and call 
+   * {@link FacesWrapper#getWrapped()} on the instance.</p>
+   * 
+   * @param factoryName Fully qualified name of the JavaServer Faces factory for which an

+   *                    implementation instance is requested
+   *                    
+   * @return A per-web-application instance of the appropriate implementation class for the

+   *         specified JavaServer Faces factory class
+   *         
+   * @throws FacesException if the web application class loader cannot be identified 
+   * @throws FacesException if an instance of the configured factory implementation class

+   *         cannot be loaded 
+   * @throws FacesException if an instance of the configured factory implementation class

+   *         cannot be instantiated 
+   * @throws IllegalArgumentException if <code>factoryname</code> does not identify
a standard 
+   *         JavaServer Faces factory name 
+   * @throws IllegalStateException if there is no configured factory implementation class

+   *         for the specified factory name 
+   * @throws NullPointerException if <code>factoryname</code> is null
+   */
   public static Object getFactory(String factoryName) throws FacesException
   {
         if(factoryName == null)



Mime
View raw message