Macro (PMD Velocity 6.25.0 API)

java.lang.Object
- net.sourceforge.pmd.lang.vm.directive.Directive
- - net.sourceforge.pmd.lang.vm.directive.Macro

All Implemented Interfaces:

Cloneable
```
@Deprecated
public class Macro
extends Directive
```
Deprecated.
for removal in PMD 7.0.0

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.

Version:

$Id: Macro.java 746438 2009-02-21 05:41:24Z nbubna $

Author:

Geir Magnusson Jr., Henning P. Schmiedehausen

Field Summary
- Fields inherited from class net.sourceforge.pmd.lang.vm.directive.Directive
  BLOCK, LINE

Constructor Summary

Constructors
Constructor Description

Macro()
Deprecated.

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method	Description
`String`	`getName()`	Deprecated. Return name of this directive.
`int`	`getType()`	Deprecated. Return type of this directive.
`boolean`	`isScopeProvided()`	Deprecated. Since this class does no processing of content, there is never a need for an internal scope.

Methods inherited from class net.sourceforge.pmd.lang.vm.directive.Directive
getColumn, getLine, getScopeName, getTemplateName, setLocation, setLocation

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Macro
```
public Macro()
```
    Deprecated.
- Method Detail
  - getName
```
public String getName()
```
    Deprecated.
    
    Return name of this directive.
    
    Specified by:
    
    getName in class Directive
    
    Returns:
    
    The name of this directive.
  - getType
```
public int getType()
```
    Deprecated.
    
    Return type of this directive.
    
    Specified by:
    
    getType in class Directive
    
    Returns:
    
    The type of this directive.
  - isScopeProvided
```
public boolean isScopeProvided()
```
    Deprecated.
    
    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.