bboss.org.apache.velocity.runtime.directive

类 RuntimeMacro

java.lang.Object

bboss.org.apache.velocity.runtime.directive.Directive

bboss.org.apache.velocity.runtime.directive.RuntimeMacro

所有已实现的接口:

DirectiveConstants, java.lang.Cloneable

public class RuntimeMacro
extends Directive

This class acts as a proxy for potential macros. When the AST is built this class is inserted as a placeholder for the macro (whether or not the macro is actually defined). At render time we check whether there is a implementation for the macro call. If an implementation cannot be found the literal text is rendered.

从以下版本开始:

1.6

字段概要

字段

限定符和类型	字段和说明
protected boolean	strictRef Indicates if we are running in strict reference mode.

从类继承的字段 bboss.org.apache.velocity.runtime.directive.Directive

rsvc

从接口继承的字段 bboss.org.apache.velocity.runtime.directive.DirectiveConstants

BLOCK, LINE

构造器概要

构造器

构造器和说明
RuntimeMacro(java.lang.String macroName) Create a RuntimeMacro instance.

方法概要

限定符和类型	方法和说明
java.lang.String	getName() Return name of this Velocimacro.
java.lang.String	getScopeName() Override to always return "macro".
int	getType() Velocimacros are always LINE type directives.
void	init(RuntimeServices rs, InternalContextAdapter context, Node node) Intialize the Runtime macro.
boolean	render(InternalContextAdapter context, java.io.Writer writer, Node node) Velocimacro implementation is not known at the init time.
boolean	render(InternalContextAdapter context, java.io.Writer writer, Node node, Renderable body) This method is used with BlockMacro when we want to render a macro with a body AST.

从类继承的方法 bboss.org.apache.velocity.runtime.directive.Directive

getColumn, getLine, getTemplateName, isScopeProvided, makeScope, postRender, preRender, setLocation, setLocation

从类继承的方法 java.lang.Object

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

字段详细资料

strictRef

protected boolean strictRef

Indicates if we are running in strict reference mode.

构造器详细资料

RuntimeMacro

public RuntimeMacro(java.lang.String macroName)

Create a RuntimeMacro instance. Macro name and source template stored for later use.

参数:

macroName - name of the macro

方法详细资料

getName

public java.lang.String getName()

Return name of this Velocimacro.

指定者:

getName 在类中 Directive

返回:

The name of this Velocimacro.

getScopeName

public java.lang.String getScopeName()

Override to always return "macro". We don't want to use the macro name here, since when writing VTL that uses the scope, we are within a #macro call. The macro name will instead be used as the scope name when defining the body of a BlockMacro.

覆盖:

getScopeName 在类中 Directive

getType

public int getType()

Velocimacros are always LINE type directives.

指定者:

getType 在类中 Directive

返回:

The type of this directive.

init

public void init(RuntimeServices rs,
                 InternalContextAdapter context,
                 Node node)

Intialize the Runtime macro. At the init time no implementation so we just save the values to use at the render time.

覆盖:

init 在类中 Directive

参数:

rs - runtime services

context - InternalContextAdapter

node - node containing the macro call

render

public boolean render(InternalContextAdapter context,
                      java.io.Writer writer,
                      Node node)
               throws java.io.IOException,
                      ResourceNotFoundException,
                      ParseErrorException,
                      MethodInvocationException

Velocimacro implementation is not known at the init time. So look for a implementation in the macro libaries and if finds one renders it. The actual rendering is delegated to the VelocimacroProxy object. When looking for a macro we first loot at the template with has the macro call then we look at the macro lbraries in the order they appear in the list. If a macro has many definitions above look up will determine the precedence.

指定者:

render 在类中 Directive

参数:

context -

writer -

node -

返回:

true if the rendering is successful

抛出:

java.io.IOException

ResourceNotFoundException

ParseErrorException

MethodInvocationException

render

public boolean render(InternalContextAdapter context,
                      java.io.Writer writer,
                      Node node,
                      Renderable body)
               throws java.io.IOException,
                      ResourceNotFoundException,
                      ParseErrorException,
                      MethodInvocationException

This method is used with BlockMacro when we want to render a macro with a body AST.

参数:

context -

writer -

node -

body - AST block that was enclosed in the macro body.

返回:

true if the rendering is successful

抛出:

java.io.IOException

ResourceNotFoundException

ParseErrorException

MethodInvocationException