Velocity Macro with Parameters

This Example shows you how to use macro with parameters in velocity template.

Velocity Macro with Parameters

Velocity Macro with Parameters

     

This Example shows you how to use macro with parameters in velocity  template.

Example given below show you, how to display date and time velocity. The method used in this example are described below:- 

1:- Initialize velocity run time engine through method  init().
2:- Create object of VelocityContext Class.
3:- Create Template class object, Template  class object is used for controlling template methods and properties.

template.merge(context, writer): Merge method of the Template class is used here for merging  the VelocityContext class object to produce the output. Template  class object is used for controlling template methods and properties. #add($list): This method is used to call the add function created above.

 

MacroWithParameter.java

import java.io.*;

import org.apache.velocity.*;
import org.apache.velocity.app.Velocity;
import org.apache.velocity.tools.generic.RenderTool;

public class UseMacro {

  public static void main(String[] args) throws Exception {
  Velocity.init();
  Template template = Velocity.getTemplate("./src/MacroWithParameter.vm");

  VelocityContext context = new VelocityContext();

  Writer writer = new StringWriter();
  template.merge(context, writer);

  System.out.println(writer);
  }
}

MacroWithParameter.vm
#macro(add $list)
#set($total=0)
#foreach($item in $list)
$item
#set($total =$total+$item)
#end
--------------
total = $total
#end

#set ($list = [1, 2, 2])
#add($list)

Output:
1
2
2
--------------
total =  5

Download code

Tutorials

  1. What is Velocity?
  2. Call class methods
  3. Calculation Example
  4. Reference Class Properties
  5. XML handling in a template using Velocity
  6. Show output as a xml file using Velocity
  7. Define and use Macro in Velocity
  8. Show content of .vm file as output using Velocity
  9. How to pass java.util.Properties in properties
  10. How to use Map in velocity
  11. Velocity Macro with Parameters
  12. Use macro to wrap HTML tags in velocity
  13. How to use foreach loop in velocity
  14. How to use List in velocity
  15. Velocity Iterator Tool Example
  16. Include template file in another template file
  17. Velocity with External Properties
  18. Date Tool Example
  19. Use if and elseif statements in velocity
  20. Use if else and end statements in velocity
  21. Use if in velocity
  22. How to define variable in Velocity
  23. How to set a variable value using velocity
  24. Foreach loop with negative index in velocity
  25. Use Velocity to generate HTML document
  26. Data Type: String
  27. Data Type: number
  28. Data Type: bool
  29. How to use dollar sign in velocity
  30. Velocity