Package com.opensymphony.module.sitemesh.mapper

Class AbstractDecoratorMapper

java.lang.Object

com.opensymphony.module.sitemesh.mapper.AbstractDecoratorMapper

All Implemented Interfaces:

DecoratorMapper

Direct Known Subclasses:

AgentDecoratorMapper, ConfigDecoratorMapper, CookieDecoratorMapper, FileDecoratorMapper, FrameSetDecoratorMapper, InlineDecoratorMapper, LanguageDecoratorMapper, OSDecoratorMapper, PageDecoratorMapper, ParameterDecoratorMapper, PrintableDecoratorMapper, RobotDecoratorMapper, SessionDecoratorMapper

public abstract class AbstractDecoratorMapper
extends Object
implements DecoratorMapper

Abstract DecoratorMapper implementation for easy creation of new DecoratorMappers.

Typically, an implementation would override getNamedDecorator() or getDecorator(). If a Decorator cannot be returned from either of these, then they should delegate to their superclass.

See Also:

• DecoratorMapper

Field Summary

Fields

Modifier and Type	Field	Description
protected Config	config
protected DecoratorMapper	parent	Parent DecoratorMapper.

Constructor Summary

Constructors

Constructor	Description
AbstractDecoratorMapper()

Method Summary

Modifier and Type	Method	Description
Decorator	getDecorator(jakarta.servlet.http.HttpServletRequest request, Page page)	Delegate to parent.
Decorator	getNamedDecorator(jakarta.servlet.http.HttpServletRequest request, String name)	Delegate to parent.
void	init(Config config, Properties properties, DecoratorMapper parent)	Set parent.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

parent

protected DecoratorMapper parent

Parent DecoratorMapper.

config

protected Config config

Constructor Details

AbstractDecoratorMapper

public AbstractDecoratorMapper()

Method Details

init

public void init(Config config,
 Properties properties,
 DecoratorMapper parent)
          throws InstantiationException

Set parent.

Specified by:

init in interface DecoratorMapper

Parameters:

config - Config supplied by Servlet or Filter.

properties - Any initialization properties (specific to implementation).

Throws:

InstantiationException - should be thrown if the implementation cannot be initialized properly.

getDecorator

public Decorator getDecorator(jakarta.servlet.http.HttpServletRequest request,
 Page page)

Delegate to parent.

Specified by:

getDecorator in interface DecoratorMapper

getNamedDecorator

public Decorator getNamedDecorator(jakarta.servlet.http.HttpServletRequest request,
 String name)

Delegate to parent.

Specified by:

getNamedDecorator in interface DecoratorMapper