Author: ssmiweve
Date: 2008-11-05 13:38:35 +0100 (Wed, 05 Nov 2008)
New Revision: 6905
Modified:
trunk/site-spi/src/main/java/no/sesat/search/site/config/AbstractResourceLoader.java
Log:
better javadoc around how to use PropertiesLoader, DocumentLoader, and
BytecodeLoader with AbstractResourceLoder implementations.
Modified:
trunk/site-spi/src/main/java/no/sesat/search/site/config/AbstractResourceLoader.java
===================================================================
---
trunk/site-spi/src/main/java/no/sesat/search/site/config/AbstractResourceLoader.java
2008-11-05 08:22:53 UTC (rev 6904)
+++
trunk/site-spi/src/main/java/no/sesat/search/site/config/AbstractResourceLoader.java
2008-11-05 12:38:35 UTC (rev 6905)
@@ -48,6 +48,43 @@
* This avoids the problem of having to order loading of applications in the
container because of static initialisers
* using resources from the search-front-config application.
*
+ * <br/>
+ *
+ * Because the loading is backgrounded it is important to wait until it is
finished.
+ * This is done by calling abut()
+ *
+ * <br/><br/>
+ *
+ * Example usecases:<br/>
+ * (1)<pre>
+ * // load custom.properties into props in skin's WEB-INF/classes/
+ * Site site = ...;
+ * PropertiesContext context = ...;
+ * Properties props = new Properties();
+ * PropertiesLoader loader =
context.newPropertiesLoader(site.getSiteContext(), "custom.properties", props);
+ * loader.abut();
+ * props.getProperty(...);
+ * <pre/>
+ * (2)<pre>
+ * // create document from my.xml located in skin's WEB-INF/classes/
+ * Site site = ...;
+ * DocumentContext context = ...;
+ * final DocumentBuilderFactory factory = DocumentBuilderFactory.newInstance();
+ * factory.setValidating(false);
+ * final DocumentBuilder builder = factory.newDocumentBuilder();
+ * loader = context.newDocumentLoader(site.getSiteContext(), "my.xml",
builder);
+ * loader.abut();
+ * Document doc = loader.getDocument();
+ * </pre>
+ * (3)<pre>
+ * // read a class file from a jar file located in skin's WEB-INF/lib/
+ * Site site = ...;
+ * BytecodeContext context = ...;
+ * BytecodeLoader loader=
context.newBytecodeLoader(site.getSiteContext(),"Example.class", "Example.jar");
+ * loader.abut()
+ * byte[] bytes = loader.getBytecode();
+ * </pre>
+ *
* @version $Id$
*
*/
_______________________________________________
Kernel-commits mailing list
[email protected]
http://sesat.no/mailman/listinfo/kernel-commits
