Return-Path: X-Original-To: apmail-freemarker-notifications-archive@minotaur.apache.org Delivered-To: apmail-freemarker-notifications-archive@minotaur.apache.org Received: from mail.apache.org (hermes.apache.org [140.211.11.3]) by minotaur.apache.org (Postfix) with SMTP id BD49018528 for ; Tue, 3 Nov 2015 23:04:29 +0000 (UTC) Received: (qmail 14182 invoked by uid 500); 3 Nov 2015 23:04:17 -0000 Delivered-To: apmail-freemarker-notifications-archive@freemarker.apache.org Received: (qmail 14164 invoked by uid 500); 3 Nov 2015 23:04:17 -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 14154 invoked by uid 99); 3 Nov 2015 23:04:17 -0000 Received: from Unknown (HELO spamd3-us-west.apache.org) (209.188.14.142) by apache.org (qpsmtpd/0.29) with ESMTP; Tue, 03 Nov 2015 23:04:17 +0000 Received: from localhost (localhost [127.0.0.1]) by spamd3-us-west.apache.org (ASF Mail Server at spamd3-us-west.apache.org) with ESMTP id 767F7180233 for ; Tue, 3 Nov 2015 23:04:16 +0000 (UTC) X-Virus-Scanned: Debian amavisd-new at spamd3-us-west.apache.org X-Spam-Flag: NO X-Spam-Score: 2.991 X-Spam-Level: ** X-Spam-Status: No, score=2.991 tagged_above=-999 required=6.31 tests=[KAM_ASCII_DIVIDERS=0.8, KAM_LAZY_DOMAIN_SECURITY=1, KAM_MANYCOMMENTS=1.2, T_RP_MATCHES_RCVD=-0.01, URIBL_BLOCKED=0.001] autolearn=disabled Received: from mx1-us-east.apache.org ([10.40.0.8]) by localhost (spamd3-us-west.apache.org [10.40.0.10]) (amavisd-new, port 10024) with ESMTP id aCyegmZOzb4H for ; Tue, 3 Nov 2015 23:03:54 +0000 (UTC) Received: from mail.apache.org (hermes.apache.org [140.211.11.3]) by mx1-us-east.apache.org (ASF Mail Server at mx1-us-east.apache.org) with SMTP id 95BA0444DE for ; Tue, 3 Nov 2015 23:03:34 +0000 (UTC) Received: (qmail 12485 invoked by uid 99); 3 Nov 2015 23:03:32 -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, 03 Nov 2015 23:03:32 +0000 Received: by git1-us-west.apache.org (ASF Mail Server at git1-us-west.apache.org, from userid 33) id A8A9EE03E8; Tue, 3 Nov 2015 23:03:32 +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, 03 Nov 2015 23:04:16 -0000 Message-Id: In-Reply-To: <240b8761679d42cc9fbf47d1ca4a3861@git.apache.org> References: <240b8761679d42cc9fbf47d1ca4a3861@git.apache.org> X-Mailer: ASF-Git Admin Mailer Subject: [46/51] [partial] incubator-freemarker-site git commit: Uploaded freemarker.org/builds content from the previous (non-ASF) server http://git-wip-us.apache.org/repos/asf/incubator-freemarker-site/blob/b35e4aa5/builds/2.3.24-pre01/_html/api/freemarker/cache/ByteArrayTemplateLoader.html ---------------------------------------------------------------------- diff --git a/builds/2.3.24-pre01/_html/api/freemarker/cache/ByteArrayTemplateLoader.html b/builds/2.3.24-pre01/_html/api/freemarker/cache/ByteArrayTemplateLoader.html new file mode 100644 index 0000000..c4afaee --- /dev/null +++ b/builds/2.3.24-pre01/_html/api/freemarker/cache/ByteArrayTemplateLoader.html @@ -0,0 +1,505 @@ + + + + + + +ByteArrayTemplateLoader (FreeMarker 2.3.24-pre01 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
freemarker.cache
+

Class ByteArrayTemplateLoader

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

      Constructor Detail

      + + + +
        +
      • +

        ByteArrayTemplateLoader

        +
        public ByteArrayTemplateLoader()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        putTemplate

        +
        public void putTemplate(String name,
+                        byte[] templateSource)
        +
        Puts a template into the loader. A call to this method is identical to + the call to the three-arg putTemplate(String, byte[], long) + passing System.currentTimeMillis() as the third argument.
        +
        +
        Parameters:
        +
        name - the name of the template.
        +
        templateSource - the source code of the template.
        +
        +
        • +
      + + + +
        +
      • +

        putTemplate

        +
        public void putTemplate(String name,
+                        byte[] templateSource,
+                        long lastModified)
        +
        Puts a template into the loader. The name can contain slashes to denote + logical directory structure, but must not start with a slash. If the + method is called multiple times for the same name and with different + last modified time, the configuration's template cache will reload the + template according to its own refresh settings (note that if the refresh + is disabled in the template cache, the template will not be reloaded). + Also, since the cache uses lastModified to trigger reloads, calling the + method with different source and identical timestamp won't trigger + reloading.
        +
        +
        Parameters:
        +
        name - the name of the template.
        +
        templateSource - the source code of the template.
        +
        lastModified - the time of last modification of the template in + terms of System.currentTimeMillis()
        +
        +
        • +
      + + + + + + + +
        +
      • +

        findTemplateSource

        +
        public Object findTemplateSource(String name)
        +
        Description copied from interface: TemplateLoader
        +
        Finds the template in the backing storage and returns an object that identifies the storage location where the + template can be loaded from. See the return value for more information.
        +
        +
        Specified by:
        +
        findTemplateSource in interface TemplateLoader
        +
        Parameters:
        +
        name - The name of the template, already localized and normalized by the + cache. It is completely up to the loader implementation to + interpret the name, however it should expect to receive hierarchical paths where path components are + separated by a slash (not backslash). Backslashes (or any other OS specific separator character) are + not considered as separators by FreeMarker, and thus they will not be replaced with slash before + passing to this method, so it's up to the template loader to handle them (say, be throwing and + exception that tells the user that the path (s)he has entered is invalid, as (s)he must use slash -- + typical mistake of Windows users). The passed names are always considered relative to some + loader-defined root location (often referred as the "template root directory"), and will never start + with a slash, nor will they contain a path component consisting of either a single or a double dot -- + these are all resolved by the template cache before passing the name to the loader. As a side effect, + paths that trivially reach outside template root directory, such as ../my.ftl, will be + rejected by the template cache, so they never reach the template loader. Note again, that if the path + uses backslash as path separator instead of slash as (the template loader should not accept that), the + normalization will not properly happen, as FreeMarker (the cache) recognizes only the slashes as + separators.
        +
        Returns:
        +
        An object representing the template source, which can be supplied in subsequent calls to + TemplateLoader.getLastModified(Object) and TemplateLoader.getReader(Object, String), when those are called on the + same TemplateLoader. null must be returned if the source for the template doesn't exist; + don't throw exception then! The exact type of this object is up to the TemplateLoader + implementation. As this object is possibly used as hash key in caches, and is surly compared with another + template source for equality, it must have a proper Object.equals(Object) and + Object.hashCode()) implementation. Especially, template sources that refer to the same + physical source must be equivalent, otherwise template caching can become inefficient. This is only + expected from Object.equals(Object) when the compared template sources came from the same + TemplateLoader instance. Also, it must not influence the equality if the source is open or + closed (TemplateLoader.closeTemplateSource(Object)).
        +
        +
        • +
      + + + +
        +
      • +

        getLastModified

        +
        public long getLastModified(Object templateSource)
        +
        Description copied from interface: TemplateLoader
        +
        Returns the time of last modification of the specified template source. This method is called after + findTemplateSource().
        +
        +
        Specified by:
        +
        getLastModified in interface TemplateLoader
        +
        Parameters:
        +
        templateSource - an object representing a template source, obtained through a prior call to + TemplateLoader.findTemplateSource(String). This must be an object on which + TemplateLoader.closeTemplateSource(Object) wasn't applied yet.
        +
        Returns:
        +
        the time of last modification of the specified template source, or -1 if the time is not known.
        +
        +
        • +
      + + + +
        +
      • +

        getReader

        +
        public Reader getReader(Object templateSource,
+                        String encoding)
+                 throws UnsupportedEncodingException
        +
        Description copied from interface: TemplateLoader
        +
        Returns the character stream of a template represented by the specified template source. This method is possibly + called for multiple times for the same template source object, and it must always return a Reader that + reads the template from its beginning. Before this method is called for the second time (or later), its caller + must close the previously returned Reader, and it must not use it anymore. That is, this method is not + required to support multiple concurrent readers for the same source templateSource object. + +

        + Typically, this method is called if the template is missing from the cache, or if after calling + TemplateLoader.findTemplateSource(String) and TemplateLoader.getLastModified(Object) it was determined that the cached copy + of the template is stale. Then, if it turns out that the encoding parameter used doesn't match the actual + template content (based on the #ftl encoding=... header), this method will be called for a second time + with the correct encoding parameter value.

        +
        +
        Specified by:
        +
        getReader in interface TemplateLoader
        +
        Parameters:
        +
        templateSource - an object representing a template source, obtained through a prior call to + TemplateLoader.findTemplateSource(String). This must be an object on which + TemplateLoader.closeTemplateSource(Object) wasn't applied yet.
        +
        encoding - the character encoding used to translate source bytes to characters. Some loaders may not have access + to the byte representation of the template stream, and instead directly obtain a character stream. + These loaders should ignore the encoding parameter.
        +
        Returns:
        +
        A Reader representing the template character stream. It's the responsibility of the caller (which + is TemplateCache usually) to close() it. The Reader is not required to work after + the templateSource was closed (TemplateLoader.closeTemplateSource(Object)).
        +
        Throws:
        +
        UnsupportedEncodingException
        +
        +
        • +
      + + + +
        +
      • +

        toString

        +
        public String toString()
        +
        Show class name and some details that are useful in template-not-found errors.
        +
        +
        Overrides:
        +
        toString in class Object
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + http://git-wip-us.apache.org/repos/asf/incubator-freemarker-site/blob/b35e4aa5/builds/2.3.24-pre01/_html/api/freemarker/cache/CacheStorage.html ---------------------------------------------------------------------- diff --git a/builds/2.3.24-pre01/_html/api/freemarker/cache/CacheStorage.html b/builds/2.3.24-pre01/_html/api/freemarker/cache/CacheStorage.html new file mode 100644 index 0000000..73fe8db --- /dev/null +++ b/builds/2.3.24-pre01/_html/api/freemarker/cache/CacheStorage.html @@ -0,0 +1,281 @@ + + + + + + +CacheStorage (FreeMarker 2.3.24-pre01 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
freemarker.cache
+

Interface CacheStorage

+
+
+
+ +
+
+ +
+
+ +
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + http://git-wip-us.apache.org/repos/asf/incubator-freemarker-site/blob/b35e4aa5/builds/2.3.24-pre01/_html/api/freemarker/cache/CacheStorageWithGetSize.html ---------------------------------------------------------------------- diff --git a/builds/2.3.24-pre01/_html/api/freemarker/cache/CacheStorageWithGetSize.html b/builds/2.3.24-pre01/_html/api/freemarker/cache/CacheStorageWithGetSize.html new file mode 100644 index 0000000..1ca2663 --- /dev/null +++ b/builds/2.3.24-pre01/_html/api/freemarker/cache/CacheStorageWithGetSize.html @@ -0,0 +1,248 @@ + + + + + + +CacheStorageWithGetSize (FreeMarker 2.3.24-pre01 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
freemarker.cache
+

Interface CacheStorageWithGetSize

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

      Method Detail

      + + + +
        +
      • +

        getSize

        +
        int getSize()
        +
        Returns the current number of cache entries. This is intended to be used for monitoring. Note that depending on + the implementation, the cost of this operation is not necessary trivial, although calling it a few times per + minute should not be a problem.
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + http://git-wip-us.apache.org/repos/asf/incubator-freemarker-site/blob/b35e4aa5/builds/2.3.24-pre01/_html/api/freemarker/cache/ClassTemplateLoader.html ---------------------------------------------------------------------- diff --git a/builds/2.3.24-pre01/_html/api/freemarker/cache/ClassTemplateLoader.html b/builds/2.3.24-pre01/_html/api/freemarker/cache/ClassTemplateLoader.html new file mode 100644 index 0000000..81c1a2b --- /dev/null +++ b/builds/2.3.24-pre01/_html/api/freemarker/cache/ClassTemplateLoader.html @@ -0,0 +1,505 @@ + + + + + + +ClassTemplateLoader (FreeMarker 2.3.24-pre01 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
freemarker.cache
+

Class ClassTemplateLoader

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

      Constructor Detail

      + + + + + + + +
        +
      • +

        ClassTemplateLoader

        +
        @Deprecated
+public ClassTemplateLoader(Class resourceLoaderClass)
        +
        Deprecated. It's confusing that the base path is ""; use ClassTemplateLoader(Class, String) + instead.
        +
        Creates a template loader that will use the Class.getResource(String) method of the specified class to + load the resources, and "" as base package path. This means that template paths will be resolved + relatively to the class location, that is, relatively to the directory (package) of the class.
        +
        +
        Parameters:
        +
        resourceLoaderClass - the class whose Class.getResource(String) will be used to load the templates.
        +
        +
        • +
      + + + +
        +
      • +

        ClassTemplateLoader

        +
        public ClassTemplateLoader(Class resourceLoaderClass,
+                           String basePackagePath)
        +
        Creates a template loader that will use the Class.getResource(String) method of the specified class to + load the resources, and the specified base package path (absolute or relative). + +

        + Examples: +

          +
        • Relative base path (will load from the com.example.myapplication.templates package):
          + new ClassTemplateLoader(com.example.myapplication.SomeClass.class, "templates") +
        • Absolute base path:
          + new ClassTemplateLoader(somepackage.SomeClass.class, "/com/example/myapplication/templates") +
        +
        +
        Parameters:
        +
        resourceLoaderClass - The class whose Class.getResource(String) method will be used to load the templates. Be sure + that you chose a class whose defining class-loader sees the templates. This parameter can't be + null.
        +
        basePackagePath - The package that contains the templates, in path (/-separated) format. If it doesn't start + with a / then it's relative to the path (package) of the resourceLoaderClass class. If + it starts with / then it's relative to the root of the package hierarchy. Note that path + components should be separated by forward slashes independently of the separator character used by the + underlying operating system. This parameter can't be null.
        +
        See Also:
        +
        ClassTemplateLoader(ClassLoader, String)
        +
        +
        • +
      + + + + +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getURL

        +
        protected URL getURL(String name)
        +
        Description copied from class: URLTemplateLoader
        +
        Given a template name (plus potential locale decorations) retrieves + an URL that points the template source.
        +
        +
        Specified by:
        +
        getURL in class URLTemplateLoader
        +
        Parameters:
        +
        name - the name of the sought template, including the locale + decorations.
        +
        Returns:
        +
        an URL that points to the template source, or null if it can + determine that the template source does not exist.
        +
        +
        • +
      + + + +
        +
      • +

        toString

        +
        public String toString()
        +
        Show class name and some details that are useful in template-not-found errors.
        +
        +
        Overrides:
        +
        toString in class Object
        +
        Since:
        +
        2.3.21
        +
        +
        • +
      + + + +
        +
      • +

        getResourceLoaderClass

        +
        public Class getResourceLoaderClass()
        +
        See the similar parameter of ClassTemplateLoader(Class, String); null when other mechanism is + used to load the resources.
        +
        +
        Since:
        +
        2.3.22
        +
        +
        • +
      + + + + + + + +
        +
      • +

        getBasePackagePath

        +
        public String getBasePackagePath()
        +
        See the similar parameter of ClassTemplateLoader(ClassLoader, String); note that this is a normalized + version of what was actually passed to the constructor.
        +
        +
        Since:
        +
        2.3.22
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +