Class FontCache

java.lang.Object
org.apache.fop.fonts.FontCache
All Implemented Interfaces:
Serializable
public final class FontCache extends Object implements Serializable
Fop cache (currently only used for font info caching)
See Also:

  • Field Details

    • serialVersionUID

      private static final long serialVersionUID
      Serialization Version UID. Change this value if you want to make sure the user's cache file is purged after an update.
      See Also:

    • log

      private static org.apache.commons.logging.Log log
      logging instance

    • FOP_USER_DIR

      private static final String FOP_USER_DIR
      FOP's user directory name
      See Also:

    • DEFAULT_CACHE_FILENAME

      private static final String DEFAULT_CACHE_FILENAME
      font cache file path
      See Also:

    • changed

      private transient boolean changed
      has this cache been changed since it was last read?

    • changeLock

      private final boolean[] changeLock
      change lock

    • fontfileMap

      private Map<String, FontCache.CachedFontFile> fontfileMap
      master mapping of font url -> font info. This needs to be a list, since a TTC file may contain more than 1 font.

    • failedFontMap

      private Map<String,Long> failedFontMap
      mapping of font url -> file modified date (for all fonts that have failed to load)

  • Constructor Details

    • FontCache

      public FontCache()

  • Method Details

    • readObject

      private void readObject(ObjectInputStream ois) throws ClassNotFoundException, IOException
      Throws:
      ClassNotFoundException
      IOException

    • getUserHome

      private static File getUserHome()

    • getTempDirectory

      private static File getTempDirectory()

    • toDirectory

      private static File toDirectory(String path)

    • getDefaultCacheFile

      public static File getDefaultCacheFile(boolean forWriting)
      Returns the default font cache file.
      Parameters:
      forWriting - true if the user directory should be created
      Returns:
      the default font cache file

    • load

      public static FontCache load()
      Deprecated.
      use loadFrom(File) instead
      Reads the default font cache file and returns its contents.
      Returns:
      the font cache deserialized from the file (or null if no cache file exists or if it could not be read)

    • loadFrom

      public static FontCache loadFrom(File cacheFile)
      Reads a font cache file and returns its contents.
      Parameters:
      cacheFile - the cache file
      Returns:
      the font cache deserialized from the file (or null if no cache file exists or if it could not be read)

    • save

      public void save() throws FOPException
      Deprecated.
      use saveTo(File) instead
      Writes the font cache to disk.
      Throws:
      FOPException - fop exception

    • saveTo

      public void saveTo(File cacheFile) throws FOPException
      Writes the font cache to disk.
      Parameters:
      cacheFile - the file to write to
      Throws:
      FOPException - fop exception

    • getCacheKey

      protected static String getCacheKey(EmbedFontInfo fontInfo)
      creates a key given a font info for the font mapping
      Parameters:
      fontInfo - font info
      Returns:
      font cache key

    • hasChanged

      public boolean hasChanged()
      cache has been updated since it was read
      Returns:
      if this cache has changed

    • containsFont

      public boolean containsFont(String embedUrl)
      is this font in the cache?
      Parameters:
      embedUrl - font info
      Returns:
      boolean

    • containsFont

      public boolean containsFont(EmbedFontInfo fontInfo)
      is this font info in the cache?
      Parameters:
      fontInfo - font info
      Returns:
      font

    • getFileFromUrls

      public static File getFileFromUrls(String[] urls)
      Tries to identify a File instance from an array of URLs. If there's no file URL in the array, the method returns null.
      Parameters:
      urls - array of possible font urls
      Returns:
      file font file

    • getFontFileMap

      private Map<String, FontCache.CachedFontFile> getFontFileMap()

    • addFont

      public void addFont(EmbedFontInfo fontInfo, InternalResourceResolver resourceResolver)
      Adds a font info to cache
      Parameters:
      fontInfo - font info

    • getFontFile

      public FontCache.CachedFontFile getFontFile(String embedUrl)
      Returns a font from the cache.
      Parameters:
      embedUrl - font info
      Returns:
      CachedFontFile object

    • getFontInfos

      public EmbedFontInfo[] getFontInfos(String embedUrl, long lastModified)
      Returns the EmbedFontInfo instances belonging to a font file. If the font file was modified since it was cached the entry is removed and null is returned.
      Parameters:
      embedUrl - the font URL
      lastModified - the last modified date/time of the font file
      Returns:
      the EmbedFontInfo instances or null if there's no cached entry or if it is outdated

    • removeFont

      public void removeFont(String embedUrl)
      removes font from cache
      Parameters:
      embedUrl - embed url

    • isFailedFont

      public boolean isFailedFont(String embedUrl, long lastModified)
      has this font previously failed to load?
      Parameters:
      embedUrl - embed url
      lastModified - last modified
      Returns:
      whether this is a failed font

    • registerFailedFont

      public void registerFailedFont(String embedUrl, long lastModified)
      Registers a failed font with the cache
      Parameters:
      embedUrl - embed url
      lastModified - time last modified

    • getFailedFontMap

      private Map<String,Long> getFailedFontMap()

    • clear

      public void clear()
      Clears font cache

    • getLastModified

      public static long getLastModified(URI uri)
      Retrieve the last modified date/time of a URI.
      Parameters:
      uri - the URI
      Returns:
      the last modified date/time