[jboss-cvs] JBossCache/src/org/jboss/cache ...

[Manik Surtani]

  User: msurtani
  Date: 07/04/03 18:25:49

  Modified:    src/org/jboss/cache  CacheFactory.java
  Log:
  JBCACHE-1021
  
  Revision  Changes    Path
  1.7       +9 -3      JBossCache/src/org/jboss/cache/CacheFactory.java
  
  (In the diff below, changes in quantity of whitespace are not shown.)
  
  Index: CacheFactory.java
  ===================================================================
  RCS file: /cvsroot/jboss/JBossCache/src/org/jboss/cache/CacheFactory.java,v
  retrieving revision 1.6
  retrieving revision 1.7
  diff -u -b -r1.6 -r1.7
  --- CacheFactory.java	12 Mar 2007 18:13:46 -0000	1.6
  +++ CacheFactory.java	3 Apr 2007 22:25:49 -0000	1.7
  @@ -55,9 +55,14 @@
      Cache<K, V> createCache(boolean start) throws ConfigurationException;
   
      /**
  -    * Creates and starts a {@link org.jboss.cache.Cache} instance
  +    * Creates and starts a {@link org.jboss.cache.Cache} instance.  The following are all valid calls:
  +    * <pre>
  +    *    factory.createCache("myCacheService.xml"); // file is in class path
  +    *    factory.createCache("etc/myCacheService.xml"); // file is in etc/ relative to the directory you started the JVM
  +    *    factory.createCache("/home/jbosscache/myCacheService.xml"); // file is in the /home/jbosscache directory
  +    * </pre>
       *
  -    * @param configFileName the named XML file should exist in the classpath.
  +    * @param configFileName the named XML file should exist in the classpath or should be a fully qualified or relative (to your JVM working directory) path to a file on the local file system.  Note that the classpath is checked first for the existence of this file.
       * @return a running {@link org.jboss.cache.Cache} instance
       * @throws org.jboss.cache.config.ConfigurationException
       *          if there are problems with the configuration
  @@ -67,11 +72,12 @@
      /**
       * Creates {@link Cache} instance, and optionally starts it.
       *
  -    * @param configFileName the named XML file should exist in the classpath.
  +    * @param configFileName the named XML file should exist in the classpath or should be a fully qualified or relative (to your JVM working directory) path to a file on the local file system.  Note that the classpath is checked first for the existence of this file.
       * @param start          if true, the cache is started before returning.
       * @return an optionally running {@link Cache} instance
       * @throws org.jboss.cache.config.ConfigurationException
       *          if there are problems with the configuration
  +    * @see #createCache(String) for examples on valid config file names.
       */
      Cache<K, V> createCache(String configFileName, boolean start) throws ConfigurationException;