http://xmlgraphics.apache.org/fop/: Apache FOP (Formatting Objects Processor) is the world's first print formatter driven by XSL formatting objects (XSL-FO) and the world's first output independent formatter. It is a Java application that reads a formatting object (FO) tree and renders the resulting pages to a specified output. Output formats currently supported include PDF, PCL, PS, AFP, TIFF, PNG, SVG, XML (area tree representation), Print, AWT and TXT. The primary output target is PDF. (Apache Software Foundation) 
/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

/* $Id$ */

package org.apache.fop.fonts;

import java.io.File;
import java.net.URI;

import org.apache.fop.apps.FOPException;


A factory that provides the font caching manager mechanism.

/**
 * A factory that provides the font caching manager mechanism.
 *
 */
public final class FontCacheManagerFactory {

    private FontCacheManagerFactory() {
    }

    
Create the default font caching mechanism.

Returns:the font cache manager
/**
     * Create the default font caching mechanism.
     * @return the font cache manager
     */
    public static FontCacheManager createDefault() {
        return new FontCacheManagerImpl();
    }

    
Create a disabled font caching mechanism which by definition does nothing to cache fonts.

Returns:a completely restricted font cache manager
/**
     * Create a disabled font caching mechanism which by definition does nothing to cache fonts.
     * @return a completely restricted font cache manager
     */
    public static FontCacheManager createDisabled() {
        return new DisabledFontCacheManager();
    }

    private static final class FontCacheManagerImpl implements FontCacheManager {

        
Provides a font cache file path 
/** Provides a font cache file path **/
        private File cacheFile;

        private FontCache fontCache;

        public FontCache load() {
            if (fontCache == null) {
                fontCache = FontCache.loadFrom(getCacheFile(false));
                if (fontCache == null) {
                    fontCache = new FontCache();
                }
            }
            return fontCache;
        }

        public void save() throws FOPException {
            if (fontCache != null && fontCache.hasChanged()) {
                fontCache.saveTo(getCacheFile(true));
            }
        }

        public void delete() throws FOPException {
            if (!getCacheFile(true).delete()) {
                throw new FOPException("Failed to flush the font cache file '" + cacheFile + "'.");
            }
        }

        private File getCacheFile(boolean forWriting) {
            if (cacheFile != null) {
                return cacheFile;
            }
            return FontCache.getDefaultCacheFile(forWriting);
        }

        public void setCacheFile(URI fontCacheURI) {
            cacheFile = new File(fontCacheURI);
        }
    }

    private static final class DisabledFontCacheManager implements FontCacheManager {

        public FontCache load() {
            return null;
        }

        public void save() throws FOPException {
            // nop
        }

        public void delete() throws FOPException {
            throw new FOPException("Font Cache disabled");
        }

        public void setCacheFile(URI fontCacheURI) {
            // nop
        }
    }
}