stop - Apache FreeMarker Manual

Unsupported web browser - Use a modern browser to view this website!

- Home
- Manual
- Java API

- Contribute
- Report a Bug
- Download

Manual
Previous Next

# stop

## Synopsis

    <#stop>
    or
    <#stop reason>

Where:

- `reason`: Informative message that describes the reason of the terminating error. Expression, must evaluate to a string.

## Description

Aborts template processing with the given (optional) error message. This must not be used for ending template processing in normal situations! The caller of the FreeMarker template will see this as a failed template rendering, not as a normally finished one.

This directive throws a `StopException`, and the `StopException` will hold the value of the reason parameter.

Previous Next