Return-Path: X-Original-To: archive-asf-public-internal@cust-asf2.ponee.io Delivered-To: archive-asf-public-internal@cust-asf2.ponee.io Received: from cust-asf.ponee.io (cust-asf.ponee.io [163.172.22.183]) by cust-asf2.ponee.io (Postfix) with ESMTP id 53F91200AF7 for ; Tue, 14 Jun 2016 22:36:44 +0200 (CEST) Received: by cust-asf.ponee.io (Postfix) id 528E4160A56; Tue, 14 Jun 2016 20:36:44 +0000 (UTC) Delivered-To: archive-asf-public@cust-asf.ponee.io Received: from mail.apache.org (hermes.apache.org [140.211.11.3]) by cust-asf.ponee.io (Postfix) with SMTP id 506D8160A06 for ; Tue, 14 Jun 2016 22:36:42 +0200 (CEST) Received: (qmail 39320 invoked by uid 500); 14 Jun 2016 20:36:41 -0000 Mailing-List: contact notifications-help@freemarker.incubator.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: dev@freemarker.incubator.apache.org Delivered-To: mailing list notifications@freemarker.incubator.apache.org Received: (qmail 39307 invoked by uid 99); 14 Jun 2016 20:36:41 -0000 Received: from pnap-us-west-generic-nat.apache.org (HELO spamd4-us-west.apache.org) (209.188.14.142) by apache.org (qpsmtpd/0.29) with ESMTP; Tue, 14 Jun 2016 20:36:41 +0000 Received: from localhost (localhost [127.0.0.1]) by spamd4-us-west.apache.org (ASF Mail Server at spamd4-us-west.apache.org) with ESMTP id F0105C0E26 for ; Tue, 14 Jun 2016 20:36:40 +0000 (UTC) X-Virus-Scanned: Debian amavisd-new at spamd4-us-west.apache.org X-Spam-Flag: NO X-Spam-Score: -5.446 X-Spam-Level: X-Spam-Status: No, score=-5.446 tagged_above=-999 required=6.31 tests=[KAM_LAZY_DOMAIN_SECURITY=1, RCVD_IN_DNSWL_HI=-5, RCVD_IN_MSPIKE_H3=-0.01, RCVD_IN_MSPIKE_WL=-0.01, RP_MATCHES_RCVD=-1.426] autolearn=disabled Received: from mx1-lw-eu.apache.org ([10.40.0.8]) by localhost (spamd4-us-west.apache.org [10.40.0.11]) (amavisd-new, port 10024) with ESMTP id qFCjPkNaVosv for ; Tue, 14 Jun 2016 20:36:17 +0000 (UTC) Received: from mail.apache.org (hermes.apache.org [140.211.11.3]) by mx1-lw-eu.apache.org (ASF Mail Server at mx1-lw-eu.apache.org) with SMTP id 209D160E23 for ; Tue, 14 Jun 2016 20:36:01 +0000 (UTC) Received: (qmail 36078 invoked by uid 99); 14 Jun 2016 20:36:00 -0000 Received: from git1-us-west.apache.org (HELO git1-us-west.apache.org) (140.211.11.23) by apache.org (qpsmtpd/0.29) with ESMTP; Tue, 14 Jun 2016 20:36:00 +0000 Received: by git1-us-west.apache.org (ASF Mail Server at git1-us-west.apache.org, from userid 33) id A7FB8E0AD9; Tue, 14 Jun 2016 20:36:00 +0000 (UTC) Content-Type: text/plain; charset="us-ascii" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit From: ddekany@apache.org To: notifications@freemarker.incubator.apache.org Date: Tue, 14 Jun 2016 20:36:22 -0000 Message-Id: <46ed4a1ecad04928a9d0b3559b23af53@git.apache.org> In-Reply-To: <9a8f022e226e4b28a008aaffda6bbbbe@git.apache.org> References: <9a8f022e226e4b28a008aaffda6bbbbe@git.apache.org> X-Mailer: ASF-Git Admin Mailer Subject: [24/51] [partial] incubator-freemarker-site git commit: Adding 2.3.25-incubating-voted archived-at: Tue, 14 Jun 2016 20:36:44 -0000 http://git-wip-us.apache.org/repos/asf/incubator-freemarker-site/blob/843d83cc/builds/2.3.25-incubating-voted/documentation/_html/api/freemarker/core/Environment.html ---------------------------------------------------------------------- diff --git a/builds/2.3.25-incubating-voted/documentation/_html/api/freemarker/core/Environment.html b/builds/2.3.25-incubating-voted/documentation/_html/api/freemarker/core/Environment.html new file mode 100644 index 0000000..838bcd2 --- /dev/null +++ b/builds/2.3.25-incubating-voted/documentation/_html/api/freemarker/core/Environment.html @@ -0,0 +1,2254 @@ + + + + + + +Environment (FreeMarker 2.3.25-incubating API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
freemarker.core
+

Class Environment

+
+
+ +
+
    +
  • +
    +
    +
    public final class Environment
+extends Configurable
    +
    Object that represents the runtime environment during template processing. For every invocation of a + Template.process() method, a new instance of this object is created, and then discarded when + process() returns. This object stores the set of temporary variables created by the template, the value of + settings set by the template, the reference to the data model root, etc. Everything that is needed to fulfill the + template processing job. + +

    + Data models that need to access the Environment object that represents the template processing on the + current thread can use the getCurrentEnvironment() method. + +

    + If you need to modify or read this object before or after the process call, use + Template.createProcessingEnvironment(Object rootMap, Writer out, ObjectWrapper wrapper)

    +
    • +
+
+
+ +
+
+
    +
  • + + + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getCurrentEnvironment

        +
        public static Environment getCurrentEnvironment()
        +
        Retrieves the environment object associated with the current thread, or null if there's no template + processing going on in this thread. Data model implementations that need access to the environment can call this + method to obtain the environment object that represents the template processing that is currently running on the + current thread.
        +
        • +
      + + + + + + + +
        +
      • +

        getMainTemplate

        +
        public Template getMainTemplate()
        +
        Returns the topmost Template, with other words, the one for which this Environment was created. + That template will never change, like #include or macro calls don't change it.
        +
        +
        Since:
        +
        2.3.22
        +
        See Also:
        +
        getCurrentNamespace()
        +
        +
        • +
      + + + +
        +
      • +

        getCurrentTemplate

        +
        public Template getCurrentTemplate()
        +
        Returns the Template that we are "lexically" inside at the moment. This template will change when + entering an #include or calling a macro or function in another template, or returning to yet another + template with #nested. As such, it's useful in TemplateDirectiveModel to find out if from where + the directive was called from.
        +
        +
        Since:
        +
        2.3.23
        +
        See Also:
        +
        getMainTemplate(), +getCurrentNamespace()
        +
        +
        • +
      + + + +
        +
      • +

        getCurrentDirectiveCallPlace

        +
        public DirectiveCallPlace getCurrentDirectiveCallPlace()
        +
        Gets the currently executing custom directive's call place information, or null if there's no + executing custom directive. This currently only works for calls made from templates with the <@...> + syntax. This should only be called from the TemplateDirectiveModel that was invoked with <@...>, + otherwise its return value is not defined by this API (it's usually null).
        +
        +
        Since:
        +
        2.3.22
        +
        +
        • +
      + + + + + + + +