Class Break
java.lang.Object
org.apache.velocity.runtime.directive.Directive
org.apache.velocity.runtime.directive.Break
- All Implemented Interfaces:
Cloneable
,DirectiveConstants
Break directive used for interrupting scopes.
- Version:
- $Id$
- Author:
- Jarkko Viinamaki, Nathan Bubna
-
Field Summary
Fields inherited from interface org.apache.velocity.runtime.directive.DirectiveConstants
BLOCK, LINE
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptiongetName()
Return name of this directive.int
getType()
Return type of this directive.void
init
(RuntimeServices rs, InternalContextAdapter context, Node node) simple init - init the tree and get the elementKey from the ASTboolean
Since there is no processing of content, there is never a need for an internal scope.boolean
render
(InternalContextAdapter context, Writer writer, Node node) Break directive does not actually do any rendering.Methods inherited from class org.apache.velocity.runtime.directive.Directive
getColumn, getLine, getScopeName, getTemplateName, makeScope, postRender, preRender, setLocation, setLocation
-
Constructor Details
-
Break
public Break()
-
-
Method Details
-
getName
Return name of this directive. -
getType
public int getType()Return 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 classDirective
- Returns:
- true if there will be a scope control injected into the context when rendering this directive.
-
init
simple init - init the tree and get the elementKey from the AST -
render
Break directive does not actually do any rendering. This directive throws a StopCommand which signals either the nearest Scope or the specified scope to stop rendering its content.
-