cedric 01/09/10 06:01:30
Modified: contrib/tiles/src/share/org/apache/struts/tiles
ComponentDefinitionsFactory.java
Log:
Update documentation
Revision Changes Path
1.2 +15 -17
jakarta-struts/contrib/tiles/src/share/org/apache/struts/tiles/ComponentDefinitionsFactory.java
Index: ComponentDefinitionsFactory.java
===================================================================
RCS file:
/home/cvs/jakarta-struts/contrib/tiles/src/share/org/apache/struts/tiles/ComponentDefinitionsFactory.java,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- ComponentDefinitionsFactory.java 2001/08/01 14:36:42 1.1
+++ ComponentDefinitionsFactory.java 2001/09/10 13:01:30 1.2
@@ -1,7 +1,7 @@
/*
- * $Header:
/home/cvs/jakarta-struts/contrib/tiles/src/share/org/apache/struts/tiles/ComponentDefinitionsFactory.java,v
1.1 2001/08/01 14:36:42 cedric Exp $
- * $Revision: 1.1 $
- * $Date: 2001/08/01 14:36:42 $
+ * $Header:
/home/cvs/jakarta-struts/contrib/tiles/src/share/org/apache/struts/tiles/ComponentDefinitionsFactory.java,v
1.2 2001/09/10 13:01:30 cedric Exp $
+ * $Revision: 1.2 $
+ * $Date: 2001/09/10 13:01:30 $
* $Author: cedric $
*
*/
@@ -16,36 +16,34 @@
import javax.servlet.ServletContext;
/**
-* Component repository interface.
- * This interface allows to retrieve an definition by its name, independently of
the
+ * Component repository interface.
+ * This interface allows to retrieve an definition by its name, independently of the
* factory implementation.
* Implementation must be Serializable, in order to be compliant with web Container
* having this constraint (Weblogic 6.x).
*/
-public interface ComponentDefinitionsFactory extends Serializable
+public interface ComponentDefinitionsFactory extends Serializable
{
-
+
/**
* Get a definition by its name.
- * @throws DefinitionsFactoryException An error occur while getting
-definition.
+ * @param name Name of requested definition.
+ * @param request Current servelet request
+ * @param servletContext current servlet context
+ * @throws DefinitionsFactoryException An error occur while getting definition.
* @throws NoSuchDefinitionException No definition found for specified name
- * Implementation can throw more accurate exception as a subclass of this
-exception
- @roseuid 3AF6F7E203DB
+ * Implementation can throw more accurate exception as a subclass of this
exception
*/
public ComponentDefinition getDefinition(String name, ServletRequest request,
ServletContext servletContext) throws
NoSuchDefinitionException,DefinitionsFactoryException;
-
+
/**
* Init factory.
* This method is called exactly once immediately after factory creation in
* case of internal creation (by DefinitionUtil).
* @param servletContext Servlet Context passed to newly created factory.
- * @param properties Map of name/property passed to newly created factory.
-Map can contains
- * more properties than requested.
+ * @param properties Map of name/property passed to newly created factory.
+ * Map can contains more properties than requested.
* @throws DefinitionsFactoryException An error occur during initialization.
- @roseuid 3AF6F7E30080
*/
public void initFactory(ServletContext servletContext, Map properties) throws
DefinitionsFactoryException;
}
