Stop (PMD Velocity 6.20.0 API)

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

All Implemented Interfaces:

Cloneable
```
public class Stop
extends Directive
```
This class implements the #stop directive which allows a user to stop the merging and rendering process. The #stop directive will accept a single message argument with info about the reason for stopping.

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

Constructor Summary

Constructors
Constructor Description

Stop()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`String`	`getName()`	Return name of this directive.
`int`	`getType()`	Return type of this directive.
`boolean`	`isScopeProvided()`	Since there is 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
  - Stop
```
public Stop()
```
- Method Detail
  - 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 there is 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.