java.lang.Object
java.util.AbstractMap
org.apache.velocity.runtime.directive.Scope
All Implemented Interfaces:
Map
Direct Known Subclasses:
ForeachScope

public class Scope extends AbstractMap
This handles context scoping and metadata for directives.
Version:
$Id$
Author:
Nathan Bubna
  • Field Details

    • owner

      protected final Object owner
  • Constructor Details

  • Method Details

    • entrySet

      public Set entrySet()
      Specified by:
      entrySet in interface Map
      Specified by:
      entrySet in class AbstractMap
    • get

      public Object get(Object key)
      Specified by:
      get in interface Map
      Overrides:
      get in class AbstractMap
    • put

      public Object put(Object key, Object value)
      Specified by:
      put in interface Map
      Overrides:
      put in class AbstractMap
    • stop

      protected void stop()
      Allows #stop to easily trigger the proper StopCommand for this scope.
    • getDepth

      protected int getDepth()
      Returns the number of control arguments of this type that are stacked up. This is the distance between this instance and the topmost instance, plus one. This value will never be negative or zero.
    • getTopmost

      public Scope getTopmost()
      Returns the topmost parent control reference, retrieved by simple recursion on getParent().
    • getParent

      public Scope getParent()
      Returns the parent control reference overridden by the placement of this instance in the context.
    • getReplaced

      public Object getReplaced()
      Returns the user's context reference overridden by the placement of this instance in the context. If there was none (as is hoped), then this will return null. This never returns parent controls; those are returned by getParent().
    • getInfo

      public Scope.Info getInfo()
      Returns info about the current scope for debugging purposes.