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 103C2200C2A for ; Wed, 1 Mar 2017 19:49:47 +0100 (CET) Received: by cust-asf.ponee.io (Postfix) id 0EAF3160B56; Wed, 1 Mar 2017 18:49:47 +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 B855C160B70 for ; Wed, 1 Mar 2017 19:49:44 +0100 (CET) Received: (qmail 22744 invoked by uid 500); 1 Mar 2017 18:49:44 -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 22735 invoked by uid 99); 1 Mar 2017 18:49:43 -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; Wed, 01 Mar 2017 18:49:43 +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 6152EC9D64 for ; Wed, 1 Mar 2017 18:49:43 +0000 (UTC) X-Virus-Scanned: Debian amavisd-new at spamd4-us-west.apache.org X-Spam-Flag: NO X-Spam-Score: -5.367 X-Spam-Level: X-Spam-Status: No, score=-5.367 tagged_above=-999 required=6.31 tests=[KAM_ASCII_DIVIDERS=0.8, KAM_MANYCOMMENTS=1.2, RCVD_IN_DNSWL_HI=-5, RCVD_IN_MSPIKE_H3=-0.01, RCVD_IN_MSPIKE_WL=-0.01, RP_MATCHES_RCVD=-2.999, SPF_NEUTRAL=0.652] 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 NtEAuZfY00gR for ; Wed, 1 Mar 2017 18:49:16 +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 D00AA60D8C for ; Wed, 1 Mar 2017 18:48:53 +0000 (UTC) Received: (qmail 18486 invoked by uid 99); 1 Mar 2017 18:48:37 -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; Wed, 01 Mar 2017 18:48:37 +0000 Received: by git1-us-west.apache.org (ASF Mail Server at git1-us-west.apache.org, from userid 33) id D7B4AF3205; Wed, 1 Mar 2017 18:48:36 +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: Wed, 01 Mar 2017 18:48:51 -0000 Message-Id: In-Reply-To: References: X-Mailer: ASF-Git Admin Mailer Subject: [16/51] [partial] incubator-freemarker-site git commit: FM3 API javadocs archived-at: Wed, 01 Mar 2017 18:49:47 -0000 http://git-wip-us.apache.org/repos/asf/incubator-freemarker-site/blob/55a5c314/builds/fm3/api/org/apache/freemarker/core/model/TemplateBooleanModel.html ---------------------------------------------------------------------- diff --git a/builds/fm3/api/org/apache/freemarker/core/model/TemplateBooleanModel.html b/builds/fm3/api/org/apache/freemarker/core/model/TemplateBooleanModel.html new file mode 100644 index 0000000..30dd1cd --- /dev/null +++ b/builds/fm3/api/org/apache/freemarker/core/model/TemplateBooleanModel.html @@ -0,0 +1,301 @@ + + + + + + +TemplateBooleanModel (FreeMarker 3.0.0-nightly-incubating API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
org.apache.freemarker.core.model
+

Interface TemplateBooleanModel

+
+
+
+
    +
  • +
    +
    All Superinterfaces:
    +
    TemplateModel
    +
    +
    +
    +
    public interface TemplateBooleanModel
+extends TemplateModel
    +
    "boolean" template language data type; same as in Java; either true or false. + +

    + Objects of this type should be immutable, that is, calling getAsBoolean() should always return the same + value as for the first time.

    +
    • +
+
+
+ +
+
+ +
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + http://git-wip-us.apache.org/repos/asf/incubator-freemarker-site/blob/55a5c314/builds/fm3/api/org/apache/freemarker/core/model/TemplateCollectionModel.html ---------------------------------------------------------------------- diff --git a/builds/fm3/api/org/apache/freemarker/core/model/TemplateCollectionModel.html b/builds/fm3/api/org/apache/freemarker/core/model/TemplateCollectionModel.html new file mode 100644 index 0000000..bbad62d --- /dev/null +++ b/builds/fm3/api/org/apache/freemarker/core/model/TemplateCollectionModel.html @@ -0,0 +1,273 @@ + + + + + + +TemplateCollectionModel (FreeMarker 3.0.0-nightly-incubating API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
org.apache.freemarker.core.model
+

Interface TemplateCollectionModel

+
+
+
+
    +
  • +
    +
    All Superinterfaces:
    +
    TemplateModel
    +
    +
    +
    All Known Subinterfaces:
    +
    TemplateCollectionModelEx
    +
    +
    +
    All Known Implementing Classes:
    +
    CollectionAndSequence, DefaultEnumerationAdapter, DefaultIterableAdapter, DefaultIteratorAdapter, DefaultNonListCollectionAdapter, SimpleCollection
    +
    +
    +
    +
    public interface TemplateCollectionModel
+extends TemplateModel
    +
    "collection" template language data type: a collection of values that can be enumerated, but can't be or not meant to + be accessed by index or key. As such, this is not a super-interface of TemplateSequenceModel, and + implementations of that interface needn't also implement this interface just because they can. They should though, if + enumeration with this interface is significantly faster than enumeration by index. The #list directive will + enumerate using this interface if it's available. + +

    + The enumeration should be repeatable if that's possible with reasonable effort, otherwise a second enumeration + attempt is allowed to throw an TemplateModelException. Generally, the interface user Java code need not + handle that kind of exception, as in practice only the template author can handle it, by not listing such collections + twice. + +

    + Note that to wrap Java's Collection, you should implement TemplateCollectionModelEx, not just this + interface.

    +
    • +
+
+
+ +
+
+ +
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + http://git-wip-us.apache.org/repos/asf/incubator-freemarker-site/blob/55a5c314/builds/fm3/api/org/apache/freemarker/core/model/TemplateCollectionModelEx.html ---------------------------------------------------------------------- diff --git a/builds/fm3/api/org/apache/freemarker/core/model/TemplateCollectionModelEx.html b/builds/fm3/api/org/apache/freemarker/core/model/TemplateCollectionModelEx.html new file mode 100644 index 0000000..4722ee1 --- /dev/null +++ b/builds/fm3/api/org/apache/freemarker/core/model/TemplateCollectionModelEx.html @@ -0,0 +1,316 @@ + + + + + + +TemplateCollectionModelEx (FreeMarker 3.0.0-nightly-incubating API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
org.apache.freemarker.core.model
+

Interface TemplateCollectionModelEx

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

      Method Detail

      + + + + + + + +
        +
      • +

        isEmpty

        +
        boolean isEmpty()
+         throws TemplateModelException
        +
        Returns if the collection contains any elements. This differs from size() != 0 only in that the exact + number of items need not be calculated.
        +
        +
        Throws:
        +
        TemplateModelException
        +
        +
        • +
      + + + +
        +
      • +

        contains

        +
        boolean contains(TemplateModel item)
+          throws TemplateModelException
        +
        Tells if a given value occurs in the collection, according the rules of the wrapped collection. As of 2.3.22, + this interface is not yet utilized by FTL, and certainly it won't be earlier than 2.4.0. The usefulness of this + method is questionable, as the equality rules of Java differs from that of FTL, hence, calling this won't be + equivalent with ?seq_contains(e).
        +
        +
        Throws:
        +
        TemplateModelException
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + http://git-wip-us.apache.org/repos/asf/incubator-freemarker-site/blob/55a5c314/builds/fm3/api/org/apache/freemarker/core/model/TemplateDateModel.html ---------------------------------------------------------------------- diff --git a/builds/fm3/api/org/apache/freemarker/core/model/TemplateDateModel.html b/builds/fm3/api/org/apache/freemarker/core/model/TemplateDateModel.html new file mode 100644 index 0000000..652904a --- /dev/null +++ b/builds/fm3/api/org/apache/freemarker/core/model/TemplateDateModel.html @@ -0,0 +1,386 @@ + + + + + + +TemplateDateModel (FreeMarker 3.0.0-nightly-incubating API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
org.apache.freemarker.core.model
+

Interface TemplateDateModel

+
+
+
+
    +
  • +
    +
    All Superinterfaces:
    +
    TemplateModel
    +
    +
    +
    All Known Implementing Classes:
    +
    SimpleDate
    +
    +
    +
    +
    public interface TemplateDateModel
+extends TemplateModel
    +
    "date", "time" and "date-time" template language data types: corresponds to Date. Contrary to Java, + FreeMarker distinguishes date (no time part), time and date-time values. + +

    + Objects of this type should be immutable, that is, calling getAsDate() and getDateType() should + always return the same value as for the first time.

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

      Field Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Fields 
      Modifier and TypeField and Description
      static intDATE +
      The date model represents a date value (no time part).
      +
      static intDATETIME +
      The date model represents a date-time value (also known as timestamp).
      +
      static intTIME +
      The date model represents a time value (no date part).
      +
      static ListTYPE_NAMES 
      static intUNKNOWN +
      It is not known whether the date represents a date, a time, or a date-time value.
      +
      + +
      • +
    + + +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        UNKNOWN

        +
        static final int UNKNOWN
        +
        It is not known whether the date represents a date, a time, or a date-time value. + This often leads to exceptions in templates due to ambiguities it causes, so avoid it if possible.
        +
        +
        See Also:
        +
        Constant Field Values
        +
        +
        • +
      + + + +
        +
      • +

        TIME

        +
        static final int TIME
        +
        The date model represents a time value (no date part).
        +
        +
        See Also:
        +
        Constant Field Values
        +
        +
        • +
      + + + +
        +
      • +

        DATE

        +
        static final int DATE
        +
        The date model represents a date value (no time part).
        +
        +
        See Also:
        +
        Constant Field Values
        +
        +
        • +
      + + + +
        +
      • +

        DATETIME

        +
        static final int DATETIME
        +
        The date model represents a date-time value (also known as timestamp).
        +
        +
        See Also:
        +
        Constant Field Values
        +
        +
        • +
      + + + +
        +
      • +

        TYPE_NAMES

        +
        static final List TYPE_NAMES
        +
        • +
      +
      • +
    + + +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + http://git-wip-us.apache.org/repos/asf/incubator-freemarker-site/blob/55a5c314/builds/fm3/api/org/apache/freemarker/core/model/TemplateDirectiveBody.html ---------------------------------------------------------------------- diff --git a/builds/fm3/api/org/apache/freemarker/core/model/TemplateDirectiveBody.html b/builds/fm3/api/org/apache/freemarker/core/model/TemplateDirectiveBody.html new file mode 100644 index 0000000..3af6e35 --- /dev/null +++ b/builds/fm3/api/org/apache/freemarker/core/model/TemplateDirectiveBody.html @@ -0,0 +1,246 @@ + + + + + + +TemplateDirectiveBody (FreeMarker 3.0.0-nightly-incubating API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
org.apache.freemarker.core.model
+

Interface TemplateDirectiveBody

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

      Method Detail

      + + + +
        +
      • +

        render

        +
        void render(Writer out)
+     throws TemplateException,
+            IOException
        +
        Renders the body of the directive body to the specified writer. The + writer is not flushed after the rendering. If you pass the environment's + writer, there is no need to flush it. If you supply your own writer, you + are responsible to flush/close it when you're done with using it (which + might be after multiple renderings).
        +
        +
        Parameters:
        +
        out - the writer to write the output to.
        +
        Throws:
        +
        TemplateException
        +
        IOException
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + http://git-wip-us.apache.org/repos/asf/incubator-freemarker-site/blob/55a5c314/builds/fm3/api/org/apache/freemarker/core/model/TemplateDirectiveModel.html ---------------------------------------------------------------------- diff --git a/builds/fm3/api/org/apache/freemarker/core/model/TemplateDirectiveModel.html b/builds/fm3/api/org/apache/freemarker/core/model/TemplateDirectiveModel.html new file mode 100644 index 0000000..4c198fc --- /dev/null +++ b/builds/fm3/api/org/apache/freemarker/core/model/TemplateDirectiveModel.html @@ -0,0 +1,294 @@ + + + + + + +TemplateDirectiveModel (FreeMarker 3.0.0-nightly-incubating API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
org.apache.freemarker.core.model
+

Interface TemplateDirectiveModel

+
+
+
+
    +
  • +
    +
    All Superinterfaces:
    +
    TemplateModel
    +
    +
    +
    All Known Implementing Classes:
    +
    IncludePage
    +
    +
    +
    +
    public interface TemplateDirectiveModel
+extends TemplateModel
    +
    "directive" template language data type: used as user-defined directives + (much like macros) in templates. They can do arbitrary actions, write arbitrary + text to the template output, and trigger rendering of their nested content for + any number of times. + +

    They are used in templates like <@myDirective foo=1 bar="wombat">...</@myDirective> (or as + <@myDirective foo=1 bar="wombat" /> - the nested content is optional).

    +
    +
    Since:
    +
    2.3.11
    +
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        execute

        +
        void execute(Environment env,
+             Map params,
+             TemplateModel[] loopVars,
+             TemplateDirectiveBody body)
+      throws TemplateException,
+             IOException
        +
        Executes this user-defined directive; called by FreeMarker when the user-defined + directive is called in the template.
        +
        +
        Parameters:
        +
        env - the current processing environment. Note that you can access + the output Writer by Environment.getOut().
        +
        params - the parameters (if any) passed to the directive as a + map of key/value pairs where the keys are String-s and the + values are TemplateModel instances. This is never + null. If you need to convert the template models to POJOs, + you can use the utility methods in the DeepUnwrap class.
        +
        loopVars - an array that corresponds to the "loop variables", in + the order as they appear in the directive call. ("Loop variables" are out-parameters + that are available to the nested body of the directive; see in the Manual.) + You set the loop variables by writing this array. The length of the array gives the + number of loop-variables that the caller has specified. + Never null, but can be a zero-length array.
        +
        body - an object that can be used to render the nested content (body) of + the directive call. If the directive call has no nested content (i.e., it's like + <@myDirective /> or <@myDirective></@myDirective>), then this will be + null.
        +
        Throws:
        +
        TemplateException - If any problem occurs that's not an IOException during writing the template + output.
        +
        IOException - When writing the template output fails.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +