Class Factory

  • Direct Known Subclasses:
    BaseFactory

    public abstract class Factory
    extends java.lang.Object
    Factory responsible for creating appropriate instances of implementations. This is specific to a web context and is obtained through getInstance(com.opensymphony.module.sitemesh.Config).

    The actual Factory method used is determined by the enviroment entry sitemesh.factory. If this doesn't exist, it defaults to DefaultFactory .

    Version:
    $Revision: 1.5 $
    Author:
    Joe Walnes
    • Field Summary

      Fields 
      Modifier and Type Field Description
      private static java.lang.String SITEMESH_FACTORY
      Web context lookup key
    • Constructor Summary

      Constructors 
      Constructor Description
      Factory()  
    • Method Summary

      All Methods Static Methods Instance Methods Abstract Methods Concrete Methods 
      Modifier and Type Method Description
      abstract DecoratorMapper getDecoratorMapper()
      Return instance of DecoratorMapper.
      private static java.lang.String getEnvEntry​(java.lang.String envEntry, java.lang.String defaultValue)
      Find String environment entry, or return default if not found.
      static Factory getInstance​(Config config)
      Entry-point for obtaining singleton instance of Factory.
      abstract PageParser getPageParser​(java.lang.String contentType)
      Create a PageParser suitable for the given content-type.
      abstract boolean isPathExcluded​(java.lang.String path)
      Determine whether the given path should be excluded from decoration or not.
      protected static void report​(java.lang.String msg, java.lang.Exception e)
      Report a problem.
      abstract boolean shouldParsePage​(java.lang.String contentType)
      Determine whether a Page of given content-type should be parsed or not.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Field Detail

      • SITEMESH_FACTORY

        private static final java.lang.String SITEMESH_FACTORY
        Web context lookup key
        See Also:
        Constant Field Values
    • Constructor Detail

      • Factory

        public Factory()
    • Method Detail

      • getInstance

        public static Factory getInstance​(Config config)
        Entry-point for obtaining singleton instance of Factory. The default factory class that will be instantiated can be overridden with the environment entry sitemesh.factory.
      • getDecoratorMapper

        public abstract DecoratorMapper getDecoratorMapper()
        Return instance of DecoratorMapper.
      • getPageParser

        public abstract PageParser getPageParser​(java.lang.String contentType)
        Create a PageParser suitable for the given content-type.

        For example, if the supplied parameter is text/html a parser shall be returned that can parse HTML accordingly.

        Never returns null.
        Parameters:
        contentType - The MIME content-type of the data to be parsed
        Returns:
        Appropriate PageParser for reading data
      • shouldParsePage

        public abstract boolean shouldParsePage​(java.lang.String contentType)
        Determine whether a Page of given content-type should be parsed or not.
      • isPathExcluded

        public abstract boolean isPathExcluded​(java.lang.String path)
        Determine whether the given path should be excluded from decoration or not.
      • report

        protected static void report​(java.lang.String msg,
                                     java.lang.Exception e)
        Report a problem.
      • getEnvEntry

        private static java.lang.String getEnvEntry​(java.lang.String envEntry,
                                                    java.lang.String defaultValue)
        Find String environment entry, or return default if not found.