Package com.opensymphony.module.sitemesh
Class Factory
java.lang.Object
com.opensymphony.module.sitemesh.Factory
- All Implemented Interfaces:
PageParserSelector
- Direct Known Subclasses:
BaseFactory
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.8 $
- Author:
- Joe Walnes
-
Field Summary
Fields -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionabstract DecoratorMapper
Return instance of DecoratorMapper.private static String
getEnvEntry
(String envEntry, 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
(String contentType) Create a PageParser suitable for the given content-type.abstract boolean
isPathExcluded
(String path) Determine whether the given path should be excluded from decoration or not.abstract void
refresh()
abstract boolean
shouldParsePage
(String contentType) Determine whether a Page of given content-type should be parsed or not.
-
Field Details
-
SITEMESH_FACTORY
Web context lookup key- See Also:
-
-
Constructor Details
-
Factory
public Factory()
-
-
Method Details
-
getInstance
Entry-point for obtaining singleton instance of Factory. The default factory class that will be instantiated can be overridden with the environment entrysitemesh.factory
. -
refresh
public abstract void refresh() -
getDecoratorMapper
Return instance of DecoratorMapper. -
getPageParser
Create a PageParser suitable for the given content-type.For example, if the supplied parameter is
Never returns null.text/html
a parser shall be returned that can parse HTML accordingly.- Specified by:
getPageParser
in interfacePageParserSelector
- Parameters:
contentType
- The MIME content-type of the data to be parsed- Returns:
- Appropriate
PageParser
for reading data
-
shouldParsePage
Determine whether a Page of given content-type should be parsed or not.- Specified by:
shouldParsePage
in interfacePageParserSelector
-
isPathExcluded
Determine whether the given path should be excluded from decoration or not. -
getEnvEntry
Find String environment entry, or return default if not found.
-