bboss.org.apache.velocity.runtime.directive

类 VelocimacroProxy

java.lang.Object

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

bboss.org.apache.velocity.runtime.directive.VelocimacroProxy

所有已实现的接口:

DirectiveConstants, java.lang.Cloneable

public class VelocimacroProxy
extends Directive

VelocimacroProxy.java a proxy Directive-derived object to fit with the current directive system

字段概要

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

rsvc

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

BLOCK, LINE

构造器概要

构造器

构造器和说明
VelocimacroProxy()

方法概要

限定符和类型	方法和说明
void	checkArgs(InternalContextAdapter context, Node node, boolean hasBody) check if we are calling this macro with the right number of arguments.
java.lang.String	getName() Return name of this Velocimacro.
int	getNumArgs() returns the number of ars needed for this VM
int	getType() Velocimacros are always LINE type directives.
void	init(RuntimeServices rs) Initialize members of VelocimacroProxy.
boolean	render(InternalContextAdapter context, java.io.Writer writer, Node node) How this directive is to be rendered
boolean	render(InternalContextAdapter context, java.io.Writer writer, Node node, Renderable body) Renders the macro using the context.
void	setArgArray(java.lang.String[] arr) sets the array of arguments specified in the macro definition
void	setName(java.lang.String name) sets the directive name of this VM
void	setNodeTree(SimpleNode tree)

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

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

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

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

构造器详细资料

VelocimacroProxy

public VelocimacroProxy()

方法详细资料

getName

public java.lang.String getName()

Return name of this Velocimacro.

指定者:

getName 在类中 Directive

返回:

The name of this Velocimacro.

getType

public int getType()

Velocimacros are always LINE type directives.

指定者:

getType 在类中 Directive

返回:

The type of this directive.

setName

public void setName(java.lang.String name)

sets the directive name of this VM

参数:

name -

setArgArray

public void setArgArray(java.lang.String[] arr)

sets the array of arguments specified in the macro definition

参数:

arr -

setNodeTree

public void setNodeTree(SimpleNode tree)

参数:

tree -

getNumArgs

public int getNumArgs()

returns the number of ars needed for this VM

返回:

The number of ars needed for this VM

render

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

从类复制的说明: Directive

How this directive is to be rendered

指定者:

render 在类中 Directive

返回:

True if the directive rendered successfully.

抛出:

java.io.IOException

MethodInvocationException

MacroOverflowException

render

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

Renders the macro using the context.

参数:

context - Current rendering context

writer - Writer for output

node - AST that calls the macro

返回:

True if the directive rendered successfully.

抛出:

java.io.IOException

MethodInvocationException

MacroOverflowException

init

public void init(RuntimeServices rs)

Initialize members of VelocimacroProxy. called from MacroEntry

checkArgs

public void checkArgs(InternalContextAdapter context,
                      Node node,
                      boolean hasBody)

check if we are calling this macro with the right number of arguments. If we are not, and strictArguments is active, then throw TemplateInitException. This method is called during macro render, so it must be thread safe.