Class VelocimacroProxy

Method Details

• getName

  public String getName()

  Return name of this Velocimacro.

  Specified by:

  getName in class Directive

  Returns:

  The name of this Velocimacro.

• getType

  public int getType()

  Velocimacros are always LINE type directives.

  Specified by:

  getType in class Directive

  Returns:

  The type of this directive.

• setName

  public void setName(String name)

  sets the directive name of this VM

  Parameters:

  name -

• setArgArray

  public void setArgArray(String[] arr)

  sets the array of arguments specified in the macro definition

  Parameters:

  arr -

• setNodeTree

  public void setNodeTree(SimpleNode tree)

  Parameters:

  tree -

• getNumArgs

  public int getNumArgs()

  returns the number of ars needed for this VM

  Returns:

  The number of ars needed for this VM

• render

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

  Description copied from class: Directive

  How this directive is to be rendered

  Specified by:

  render in class Directive

  Returns:

  True if the directive rendered successfully.

  Throws:

  IOException

  MethodInvocationException

  MacroOverflowException

• render

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

  Renders the macro using the context.

  Parameters:

  context - Current rendering context

  writer - Writer for output

  node - AST that calls the macro

  Returns:

  True if the directive rendered successfully.

  Throws:

  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.