org.craftercms.engine.macro.impl

Class AbstractMacro

java.lang.Object

org.craftercms.engine.macro.impl.AbstractMacro

All Implemented Interfaces:

Macro

Direct Known Subclasses:

CookieMacro, RequestParamMacro, RequestUriMacro, ScopeAttributeMacro, WebAppContextPathMacro, WebAppPathMacro

public abstract class AbstractMacro
extends Object
implements Macro

Abstract Macro that provides a macro name attribute to hold the macro name (when the macro's name is variable) and the ability to skip the macro if the name is not contained in the specified string.

Author:

Alfonso Vásquez

Field Summary

Fields

Modifier and Type	Field and Description
protected String	macroName

Constructor Summary

Constructors

Constructor and Description
AbstractMacro()

Method Summary

Methods

Modifier and Type	Method and Description
protected abstract String	createMacroName()
protected abstract String	getMacroValue(String str)
String	getName()
void	init()
String	resolve(String str)

Methods inherited from class java.lang.Object

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

Field Detail

macroName

protected String macroName

Constructor Detail

AbstractMacro

public AbstractMacro()

Method Detail

init

@PostConstruct
public void init()

getName

public String getName()

Specified by:

getName in interface Macro

resolve

public String resolve(String str)

Specified by:

resolve in interface Macro

createMacroName

protected abstract String createMacroName()

getMacroValue

protected abstract String getMacroValue(String str)