java.lang.Object
org.apache.velocity.runtime.directive.Directive
org.apache.velocity.runtime.directive.Break
All Implemented Interfaces:
Cloneable, DirectiveConstants

public class Break extends Directive
Break directive used for interrupting scopes.
Version:
$Id$
  • Field Details

    • scoped

      private boolean scoped
  • Constructor Details

    • Break

      public Break()
  • Method Details

    • 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.
    • init

      public void init(RuntimeServices rs, InternalContextAdapter context, Node node)
      simple init - init the tree and get the elementKey from the AST
      Overrides:
      init in class Directive
      Parameters:
      rs -
      context -
      node -
      Throws:
      TemplateInitException
    • render

      public boolean render(InternalContextAdapter context, Writer writer, Node node)
      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.
      Specified by:
      render in class Directive
      Parameters:
      context -
      writer -
      node -
      Returns:
      never, always throws a StopCommand