bboss.org.apache.velocity.runtime.directive

类 Macro

java.lang.Object

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

bboss.org.apache.velocity.runtime.directive.Macro

所有已实现的接口:

DirectiveConstants, java.lang.Cloneable

public class Macro
extends Directive

Macro implements the macro definition directive of VTL. example : #macro( isnull $i ) #if( $i ) $i #end #end This object is used at parse time to mainly process and register the macro. It is used inline in the parser when processing a directive.

字段概要

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

rsvc

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

BLOCK, LINE

构造器概要

构造器

构造器和说明
Macro()

方法概要

限定符和类型	方法和说明
static void	checkArgs(RuntimeServices rs, Token t, Node node, java.lang.String sourceTemplate) Used by Parser.java to do further parameter checking for macro arguments.
java.lang.String	getName() Return name of this directive.
int	getType() Return type of this directive.
void	init(RuntimeServices rs, InternalContextAdapter context, Node node) How this directive is to be initialized.
boolean	isScopeProvided() Since this class does no processing of content, there is never a need for an internal scope.
static java.lang.StringBuilder	macroToString(java.lang.StringBuilder buf, java.lang.String[] argArray) For debugging purposes.
boolean	render(InternalContextAdapter context, java.io.Writer writer, Node node) render() doesn't do anything in the final output rendering.

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

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

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

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

构造器详细资料

Macro

public Macro()

方法详细资料

getName

public java.lang.String getName()

Return name of this directive.

指定者:

getName 在类中 Directive

返回:

The name of this directive.

getType

public int getType()

Return type of this directive.

指定者:

getType 在类中 Directive

返回:

The type of this directive.

isScopeProvided

public boolean isScopeProvided()

Since this class does no processing of content, there is never a need for an internal scope.

覆盖:

isScopeProvided 在类中 Directive

返回:

true if there will be a scope control injected into the context when rendering this directive.

render

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

render() doesn't do anything in the final output rendering. There is no output from a #macro() directive.

指定者:

render 在类中 Directive

参数:

context -

writer -

node -

返回:

True if the directive rendered successfully.

抛出:

java.io.IOException

init

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

从类复制的说明: Directive

How this directive is to be initialized.

覆盖:

init 在类中 Directive

抛出:

TemplateInitException

另请参阅:

Directive.init(bboss.org.apache.velocity.runtime.RuntimeServices, bboss.org.apache.velocity.context.InternalContextAdapter, bboss.org.apache.velocity.runtime.parser.node.Node)

checkArgs

public static void checkArgs(RuntimeServices rs,
                             Token t,
                             Node node,
                             java.lang.String sourceTemplate)
                      throws java.io.IOException,
                             ParseException

Used by Parser.java to do further parameter checking for macro arguments.

抛出:

java.io.IOException

ParseException

macroToString

public static final java.lang.StringBuilder macroToString(java.lang.StringBuilder buf,
                                                          java.lang.String[] argArray)

For debugging purposes. Formats the arguments from argArray and appends them to buf.

参数:

buf - A StringBuffer. If null, a new StringBuilder is allocated.

argArray - The Macro arguments to format

返回:

A StringBuilder containing the formatted arguments. If a StringBuffer has passed in as buf, this method returns it.

从以下版本开始:

1.5