Class Macro

Method Details

• getName

  public String getName()

  Return name of this directive.

  Specified by:

  getName in class Directive

  Returns:

  The name of this directive.

• getType

  public int getType()

  Return type of this directive.

  Specified by:

  getType in class Directive

  Returns:

  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.

  Overrides:

  isScopeProvided in class Directive

  Returns:

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

• render

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

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

  Specified by:

  render in class Directive

  Parameters:

  context -

  writer -

  node -

  Returns:

  True if the directive rendered successfully.

  Throws:

  IOException

• init

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

  Description copied from class: Directive

  How this directive is to be initialized.

  Overrides:

  init in class Directive

  Throws:

  TemplateInitException

  See Also:

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

• checkArgs

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

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

  Throws:

  IOException

  ParseException

• macroToString

  public static final StringBuffer macroToString(StringBuffer buf, String[] argArray)

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

  Parameters:

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

  argArray - The Macro arguments to format

  Returns:

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

  Since:

  1.5