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 5FBC1200C39 for ; Wed, 1 Mar 2017 19:49:26 +0100 (CET) Received: by cust-asf.ponee.io (Postfix) id 5E133160B56; Wed, 1 Mar 2017 18:49:26 +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 102E7160B7F for ; Wed, 1 Mar 2017 19:49:23 +0100 (CET) Received: (qmail 22334 invoked by uid 500); 1 Mar 2017 18:49:23 -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 22325 invoked by uid 99); 1 Mar 2017 18:49:23 -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:23 +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 73DC8C9D64 for ; Wed, 1 Mar 2017 18:49:22 +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 exibqhHAw2ks for ; Wed, 1 Mar 2017 18:48:57 +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 EC80660D1D for ; Wed, 1 Mar 2017 18:48:52 +0000 (UTC) Received: (qmail 18444 invoked by uid 99); 1 Mar 2017 18:48:36 -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:36 +0000 Received: by git1-us-west.apache.org (ASF Mail Server at git1-us-west.apache.org, from userid 33) id 62ABDDFF71; 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:37 -0000 Message-Id: <8183aa7990b246e183296b08f6ecffe5@git.apache.org> In-Reply-To: References: X-Mailer: ASF-Git Admin Mailer Subject: [02/51] [partial] incubator-freemarker-site git commit: FM3 API javadocs archived-at: Wed, 01 Mar 2017 18:49:26 -0000 http://git-wip-us.apache.org/repos/asf/incubator-freemarker-site/blob/55a5c314/builds/fm3/api/org/apache/freemarker/core/model/impl/BeanAndStringModel.html ---------------------------------------------------------------------- diff --git a/builds/fm3/api/org/apache/freemarker/core/model/impl/BeanAndStringModel.html b/builds/fm3/api/org/apache/freemarker/core/model/impl/BeanAndStringModel.html new file mode 100644 index 0000000..6e2b1d2 --- /dev/null +++ b/builds/fm3/api/org/apache/freemarker/core/model/impl/BeanAndStringModel.html @@ -0,0 +1,344 @@ + + + + + + +BeanAndStringModel (FreeMarker 3.0.0-nightly-incubating API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
org.apache.freemarker.core.model.impl
+

Class BeanAndStringModel

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

      Constructor Detail

      + + + +
        +
      • +

        BeanAndStringModel

        +
        public BeanAndStringModel(Object object,
+                          DefaultObjectWrapper wrapper)
        +
        Creates a new model that wraps the specified object with BeanModel + scalar + functionality.
        +
        +
        Parameters:
        +
        object - the object to wrap into a model.
        +
        wrapper - the DefaultObjectWrapper associated with this model. + Every model has to have an associated DefaultObjectWrapper instance. The + model gains many attributes from its wrapper, including the caching + behavior, method exposure level, method-over-item shadowing policy etc.
        +
        +
        • +
      +
      • +
    + + +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + http://git-wip-us.apache.org/repos/asf/incubator-freemarker-site/blob/55a5c314/builds/fm3/api/org/apache/freemarker/core/model/impl/BeanModel.html ---------------------------------------------------------------------- diff --git a/builds/fm3/api/org/apache/freemarker/core/model/impl/BeanModel.html b/builds/fm3/api/org/apache/freemarker/core/model/impl/BeanModel.html new file mode 100644 index 0000000..640b6af --- /dev/null +++ b/builds/fm3/api/org/apache/freemarker/core/model/impl/BeanModel.html @@ -0,0 +1,681 @@ + + + + + + +BeanModel (FreeMarker 3.0.0-nightly-incubating API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
org.apache.freemarker.core.model.impl
+

Class BeanModel

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

      Constructor Detail

      + + + +
        +
      • +

        BeanModel

        +
        public BeanModel(Object object,
+                 DefaultObjectWrapper wrapper)
        +
        Creates a new model that wraps the specified object. Note that there are + specialized subclasses of this class for wrapping arrays, collections, + enumeration, iterators, and maps. Note also that the superclass can be + used to wrap String objects if only scalar functionality is needed. You + can also choose to delegate the choice over which model class is used for + wrapping to DefaultObjectWrapper.wrap(Object).
        +
        +
        Parameters:
        +
        object - the object to wrap into a model.
        +
        wrapper - the DefaultObjectWrapper associated with this model. + Every model has to have an associated DefaultObjectWrapper instance. The + model gains many attributes from its wrapper, including the caching + behavior, method exposure level, method-over-item shadowing policy etc.
        +
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        get

        +
        public TemplateModel get(String key)
+                  throws TemplateModelException
        +
        Uses Beans introspection to locate a property or method with name + matching the key name. If a method or property is found, it's wrapped + into TemplateMethodModelEx (for a method or + indexed property), or evaluated on-the-fly and the return value wrapped + into appropriate model (for a simple property) Models for various + properties and methods are cached on a per-class basis, so the costly + introspection is performed only once per property or method of a class. + (Side-note: this also implies that any class whose method has been called + will be strongly referred to by the framework and will not become + unloadable until this class has been unloaded first. Normally this is not + an issue, but can be in a rare scenario where you create many classes on- + the-fly. Also, as the cache grows with new classes and methods introduced + to the framework, it may appear as if it were leaking memory. The + framework does, however detect class reloads (if you happen to be in an + environment that does this kind of things--servlet containers do it when + they reload a web application) and flushes the cache. If no method or + property matching the key is found, the framework will try to invoke + methods with signature + non-void-return-type get(java.lang.String), + then non-void-return-type get(java.lang.Object), or + alternatively (if the wrapped object is a resource bundle) + Object getObject(java.lang.String).
        +
        +
        Specified by:
        +
        get in interface TemplateHashModel
        +
        Parameters:
        +
        key - the name by which the TemplateModel + is identified in the template.
        +
        Returns:
        +
        the TemplateModel referred to by the key, + or null if not found.
        +
        Throws:
        +
        TemplateModelException - if there was no property nor method nor + a generic get method to invoke.
        +
        +
        • +
      + + + +
        +
      • +

        hasPlainGetMethod

        +
        protected boolean hasPlainGetMethod()
        +
        Whether the model has a plain get(String) or get(Object) method
        +
        • +
      + + + + + + + + + + + + + + + +
        +
      • +

        isEmpty

        +
        public boolean isEmpty()
        +
        Tells whether the model is considered to be empty. + It is empty if the wrapped object is a 0 length String, or an empty Collection or and empty + Map, or an Iterator that has no more items, or a Boolean.FALSE, or null.
        +
        +
        Specified by:
        +
        isEmpty in interface TemplateHashModel
        +
        +
        • +
      + + + +
        +
      • +

        getAdaptedObject

        +
        public Object getAdaptedObject(Class<?> hint)
        +
        Returns the same as getWrappedObject(); to ensure that, this method will be final starting from 2.4. + This behavior of BeanModel is assumed by some FreeMarker code.
        +
        +
        Specified by:
        +
        getAdaptedObject in interface AdapterTemplateModel
        +
        Parameters:
        +
        hint - the desired class of the returned value. An implementation + should make reasonable effort to retrieve an object of the requested + class, but if that is impossible, it must at least return the underlying + object as-is. As a minimal requirement, an implementation must always + return the exact underlying object when + hint.isInstance(underlyingObject) holds. When called + with java.lang.Object.class, it should return a generic Java + object (i.e. if the model is wrapping a scripting language object that is + further wrapping a Java object, the deepest underlying Java object should + be returned).
        +
        Returns:
        +
        the underlying object, or its value accommodated for the hint + class.
        +
        +
        • +
      + + + + + + + +
        +
      • +

        size

        +
        public int size()
        +
        +
        Specified by:
        +
        size in interface TemplateHashModelEx
        +
        Returns:
        +
        the number of key/value mappings in the hash.
        +
        +
        • +
      + + + + + + + + + + + + + + + +
        +
      • +

        keySet

        +
        protected Set keySet()
        +
        Helper method to support TemplateHashModelEx. Returns the Set of + Strings which are available via the TemplateHashModel + interface. Subclasses that override invokeGenericGet to + provide additional hash keys should also override this method.
        +
        • +
      + + + + +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + http://git-wip-us.apache.org/repos/asf/incubator-freemarker-site/blob/55a5c314/builds/fm3/api/org/apache/freemarker/core/model/impl/CollectionAndSequence.html ---------------------------------------------------------------------- diff --git a/builds/fm3/api/org/apache/freemarker/core/model/impl/CollectionAndSequence.html b/builds/fm3/api/org/apache/freemarker/core/model/impl/CollectionAndSequence.html new file mode 100644 index 0000000..0e9eb22 --- /dev/null +++ b/builds/fm3/api/org/apache/freemarker/core/model/impl/CollectionAndSequence.html @@ -0,0 +1,369 @@ + + + + + + +CollectionAndSequence (FreeMarker 3.0.0-nightly-incubating API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
org.apache.freemarker.core.model.impl
+

Class CollectionAndSequence

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • org.apache.freemarker.core.model.impl.CollectionAndSequence
      • +
    +
    • +
+
+ +
+
+ +
+
+ +
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +