jeremias    2003/03/27 02:20:34

  Added:       src/java/org/apache/fop/pdf StreamCacheFactory.java
  Log:
  Factory for StreamCache instances. Supports a hint for the expected stream size so 
memory allocation optimizations can occur for the in-memory implementation.
  
  Revision  Changes    Path
  1.1                  xml-fop/src/java/org/apache/fop/pdf/StreamCacheFactory.java
  
  Index: StreamCacheFactory.java
  ===================================================================
  /*
   * $Id: StreamCache.java,v 1.3 2003/03/07 08:25:47 jeremias Exp $
   * ============================================================================
   *                    The Apache Software License, Version 1.1
   * ============================================================================
   * 
   * Copyright (C) 1999-2003 The Apache Software Foundation. All rights reserved.
   * 
   * Redistribution and use in source and binary forms, with or without modifica-
   * tion, are permitted provided that the following conditions are met:
   * 
   * 1. Redistributions of source code must retain the above copyright notice,
   *    this list of conditions and the following disclaimer.
   * 
   * 2. Redistributions in binary form must reproduce the above copyright notice,
   *    this list of conditions and the following disclaimer in the documentation
   *    and/or other materials provided with the distribution.
   * 
   * 3. The end-user documentation included with the redistribution, if any, must
   *    include the following acknowledgment: "This product includes software
   *    developed by the Apache Software Foundation (http://www.apache.org/)."
   *    Alternately, this acknowledgment may appear in the software itself, if
   *    and wherever such third-party acknowledgments normally appear.
   * 
   * 4. The names "FOP" and "Apache Software Foundation" must not be used to
   *    endorse or promote products derived from this software without prior
   *    written permission. For written permission, please contact
   *    [EMAIL PROTECTED]
   * 
   * 5. Products derived from this software may not be called "Apache", nor may
   *    "Apache" appear in their name, without prior written permission of the
   *    Apache Software Foundation.
   * 
   * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES,
   * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
   * FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
   * APACHE SOFTWARE FOUNDATION OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
   * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLU-
   * DING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
   * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
   * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
   * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
   * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
   * ============================================================================
   * 
   * This software consists of voluntary contributions made by many individuals
   * on behalf of the Apache Software Foundation and was originally created by
   * James Tauber <[EMAIL PROTECTED]>. For more information on the Apache
   * Software Foundation, please see <http://www.apache.org/>.
   */ 
  package org.apache.fop.pdf;
  
  import java.io.IOException;
  
  /**
   * This class is serves as a factory from
   */
  public class StreamCacheFactory {
  
      private static boolean defaultCacheToFile = false;
      private static StreamCacheFactory fileInstance = null;
      private static StreamCacheFactory memoryInstance = null;
  
      private boolean cacheToFile = false;
      
      /**
       * Returns an instance of a StreamCacheFactory with the requested features.
       * @param cacheToFile True if file shall be cached using a temporary file
       * @return StreamCacheFactory the requested factory
       */
      public static StreamCacheFactory getInstance(boolean cacheToFile) {
          if (cacheToFile) {
              if (fileInstance == null) {
                  fileInstance = new StreamCacheFactory(true);
              }
              return fileInstance;
          } else {
              if (memoryInstance == null) {
                  memoryInstance = new StreamCacheFactory(false);
              }
              return memoryInstance;
          }
      }
      
      /**
       * Returns an instance of a StreamCacheFactory depending on the default
       * setting for cacheToFile.
       * @return StreamCacheFactory the requested factory
       */
      public static StreamCacheFactory getInstance() {
          return getInstance(defaultCacheToFile);
      }
      
      /**
       * Sets the global default for cacheToFile
       * @param cacheToFile True if stream caches should be held in files.
       */
      public static void setDefaultCacheToFile(boolean cacheToFile) {
          defaultCacheToFile = cacheToFile;
      }
  
      /**
       * Creates a new StreamCacheFactory.
       * @param cacheToFile True if file shall be cached using a temporary file
       */
      public StreamCacheFactory(boolean cacheToFile) {
          this.cacheToFile = cacheToFile;
      }
      
      /**
       * Get the correct implementation (based on cacheToFile) of
       * StreamCache.
       * @throws IOException if there is an IO error
       * @return a new StreamCache for caching streams
       */
      public StreamCache createStreamCache() throws IOException {
          if (this.cacheToFile) {
              return new TempFileStreamCache();
          } else {
              return new InMemoryStreamCache();
          }
      }
      
      /**
       * Get the correct implementation (based on cacheToFile) of
       * StreamCache.
       * @param hintSize a hint about the approximate expected size of the buffer
       * @throws IOException if there is an IO error
       * @return a new StreamCache for caching streams
       */
      public StreamCache createStreamCache(int hintSize) throws IOException {
          if (this.cacheToFile) {
              return new TempFileStreamCache();
          } else {
              return new InMemoryStreamCache(hintSize);
          }
      }
      
      /**
       * Get the value of the global cacheToFile flag.
       * @return the current cache to file flag
       */
      public boolean getCacheToFile() {
          return this.cacheToFile;
      }
      
  
  }
  
  
  

---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]

Reply via email to