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 762FE200D42 for ; Fri, 3 Nov 2017 03:09:13 +0100 (CET) Received: by cust-asf.ponee.io (Postfix) id 71631160BE6; Fri, 3 Nov 2017 02:09:13 +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 3FB7F160BFB for ; Fri, 3 Nov 2017 03:09:11 +0100 (CET) Received: (qmail 92394 invoked by uid 500); 3 Nov 2017 02:09:10 -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 92385 invoked by uid 99); 3 Nov 2017 02:09:10 -0000 Received: from pnap-us-west-generic-nat.apache.org (HELO spamd2-us-west.apache.org) (209.188.14.142) by apache.org (qpsmtpd/0.29) with ESMTP; Fri, 03 Nov 2017 02:09:10 +0000 Received: from localhost (localhost [127.0.0.1]) by spamd2-us-west.apache.org (ASF Mail Server at spamd2-us-west.apache.org) with ESMTP id 612FA1A526B for ; Fri, 3 Nov 2017 02:09:09 +0000 (UTC) X-Virus-Scanned: Debian amavisd-new at spamd2-us-west.apache.org X-Spam-Flag: NO X-Spam-Score: -3.021 X-Spam-Level: X-Spam-Status: No, score=-3.021 tagged_above=-999 required=6.31 tests=[KAM_ASCII_DIVIDERS=0.8, KAM_MANYCOMMENTS=1.2, KAM_SHORT=0.001, RCVD_IN_DNSWL_HI=-5, RCVD_IN_MSPIKE_H3=-0.01, RCVD_IN_MSPIKE_WL=-0.01, RP_MATCHES_RCVD=-0.001, SPF_PASS=-0.001] autolearn=disabled Received: from mx1-lw-eu.apache.org ([10.40.0.8]) by localhost (spamd2-us-west.apache.org [10.40.0.9]) (amavisd-new, port 10024) with ESMTP id yqW7VRzERupk for ; Fri, 3 Nov 2017 02:08:54 +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 E580560F73 for ; Fri, 3 Nov 2017 02:08:27 +0000 (UTC) Received: (qmail 90047 invoked by uid 99); 3 Nov 2017 02:08:25 -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; Fri, 03 Nov 2017 02:08:25 +0000 Received: by git1-us-west.apache.org (ASF Mail Server at git1-us-west.apache.org, from userid 33) id DD1E1F5BEA; Fri, 3 Nov 2017 02:08:24 +0000 (UTC) Content-Type: text/plain; charset="us-ascii" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit From: woonsan@apache.org To: notifications@freemarker.incubator.apache.org Date: Fri, 03 Nov 2017 02:09:00 -0000 Message-Id: In-Reply-To: References: X-Mailer: ASF-Git Admin Mailer Subject: [38/51] [partial] incubator-freemarker-site git commit: removing 2.3.27-vosting docs archived-at: Fri, 03 Nov 2017 02:09:13 -0000 http://git-wip-us.apache.org/repos/asf/incubator-freemarker-site/blob/892f261c/builds/2.3.27-voting/documentation/_html/api/freemarker/cache/TemplateConfigurationFactoryException.html ---------------------------------------------------------------------- diff --git a/builds/2.3.27-voting/documentation/_html/api/freemarker/cache/TemplateConfigurationFactoryException.html b/builds/2.3.27-voting/documentation/_html/api/freemarker/cache/TemplateConfigurationFactoryException.html deleted file mode 100644 index 5024bdf..0000000 --- a/builds/2.3.27-voting/documentation/_html/api/freemarker/cache/TemplateConfigurationFactoryException.html +++ /dev/null @@ -1,280 +0,0 @@ - - - - - - -TemplateConfigurationFactoryException (FreeMarker 2.3.27-incubating API) - - - - - - - - - - - - -
-
freemarker.cache
-

Class TemplateConfigurationFactoryException

-
-
- -
- -
-
- -
-
-
    -
  • - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        TemplateConfigurationFactoryException

        -
        public TemplateConfigurationFactoryException(String message)
        -
      • -
      - - - -
        -
      • -

        TemplateConfigurationFactoryException

        -
        public TemplateConfigurationFactoryException(String message,
        -                                             Throwable cause)
        -
      • -
      -
    • -
    -
  • -
-
-
- - - - - - - http://git-wip-us.apache.org/repos/asf/incubator-freemarker-site/blob/892f261c/builds/2.3.27-voting/documentation/_html/api/freemarker/cache/TemplateLoader.html ---------------------------------------------------------------------- diff --git a/builds/2.3.27-voting/documentation/_html/api/freemarker/cache/TemplateLoader.html b/builds/2.3.27-voting/documentation/_html/api/freemarker/cache/TemplateLoader.html deleted file mode 100644 index 24138bd..0000000 --- a/builds/2.3.27-voting/documentation/_html/api/freemarker/cache/TemplateLoader.html +++ /dev/null @@ -1,388 +0,0 @@ - - - - - - -TemplateLoader (FreeMarker 2.3.27-incubating API) - - - - - - - - - - - - -
-
freemarker.cache
-

Interface TemplateLoader

-
-
-
- -
-
-
    -
  • - -
      -
    • - - -

      Method Summary

      - - - - - - - - - - - - - - - - - - - - - - -
      All Methods Instance Methods Abstract Methods 
      Modifier and TypeMethod and Description
      voidcloseTemplateSource(Object templateSource) -
      Closes the template source, releasing any resources held that are only required for reading the template and/or - its metadata.
      -
      ObjectfindTemplateSource(String name) -
      Finds the template in the backing storage and returns an object that identifies the storage location where the - template can be loaded from.
      -
      longgetLastModified(Object templateSource) -
      Returns the time of last modification of the specified template source.
      -
      ReadergetReader(Object templateSource, - String encoding) -
      Returns the character stream of a template represented by the specified template source.
      -
      -
    • -
    -
  • -
-
-
-
    -
  • - -
      -
    • - - -

      Method Detail

      - - - -
        -
      • -

        findTemplateSource

        -
        Object findTemplateSource(String name)
        -                   throws IOException
        -
        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.
        -
        -
        Parameters:
        -
        name - The name (template root directory relative path) 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, by throwing an - 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 - getLastModified(Object) and 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 (closeTemplateSource(Object)).
        -
        Throws:
        -
        IOException - When an error occurs that makes it impossible to find out if the template exists, or to access the - existing template. Don't throw exception if the template doesn't exist, instead return with - null then!
        -
        -
      • -
      - - - -
        -
      • -

        getLastModified

        -
        long getLastModified(Object templateSource)
        -
        Returns the time of last modification of the specified template source. This method is called after - findTemplateSource().
        -
        -
        Parameters:
        -
        templateSource - an object representing a template source, obtained through a prior call to - findTemplateSource(String). This must be an object on which - 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

        -
        Reader getReader(Object templateSource,
        -                 String encoding)
        -          throws IOException
        -
        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 - findTemplateSource(String) and 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.

        -
        -
        Parameters:
        -
        templateSource - an object representing a template source, obtained through a prior call to - findTemplateSource(String). This must be an object on which - 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 (closeTemplateSource(Object)).
        -
        Throws:
        -
        IOException - if an I/O error occurs while accessing the stream.
        -
        -
      • -
      - - - -
        -
      • -

        closeTemplateSource

        -
        void closeTemplateSource(Object templateSource)
        -                  throws IOException
        -
        Closes the template source, releasing any resources held that are only required for reading the template and/or - its metadata. This is the last method that is called by the TemplateCache for a template source, except - that Object.equals(Object) is might called later too. TemplateCache ensures that this method will - be called on every object that is returned from findTemplateSource(String).
        -
        -
        Parameters:
        -
        templateSource - the template source that should be closed.
        -
        Throws:
        -
        IOException
        -
        -
      • -
      -
    • -
    -
  • -
-
-
- - - - - - - http://git-wip-us.apache.org/repos/asf/incubator-freemarker-site/blob/892f261c/builds/2.3.27-voting/documentation/_html/api/freemarker/cache/TemplateLookupContext.html ---------------------------------------------------------------------- diff --git a/builds/2.3.27-voting/documentation/_html/api/freemarker/cache/TemplateLookupContext.html b/builds/2.3.27-voting/documentation/_html/api/freemarker/cache/TemplateLookupContext.html deleted file mode 100644 index 445dea6..0000000 --- a/builds/2.3.27-voting/documentation/_html/api/freemarker/cache/TemplateLookupContext.html +++ /dev/null @@ -1,367 +0,0 @@ - - - - - - -TemplateLookupContext (FreeMarker 2.3.27-incubating API) - - - - - - - - - - - - -
-
freemarker.cache
-

Class TemplateLookupContext

-
-
- -
- -
-
- -
-
- -
-
- - - - - - - http://git-wip-us.apache.org/repos/asf/incubator-freemarker-site/blob/892f261c/builds/2.3.27-voting/documentation/_html/api/freemarker/cache/TemplateLookupResult.html ---------------------------------------------------------------------- diff --git a/builds/2.3.27-voting/documentation/_html/api/freemarker/cache/TemplateLookupResult.html b/builds/2.3.27-voting/documentation/_html/api/freemarker/cache/TemplateLookupResult.html deleted file mode 100644 index 3f27661..0000000 --- a/builds/2.3.27-voting/documentation/_html/api/freemarker/cache/TemplateLookupResult.html +++ /dev/null @@ -1,266 +0,0 @@ - - - - - - -TemplateLookupResult (FreeMarker 2.3.27-incubating API) - - - - - - - - - - - - -
-
freemarker.cache
-

Class TemplateLookupResult

-
-
- -
- -
-
- -
-
-
    -
  • - -
      -
    • - - -

      Method Detail

      - - - - - - - -
        -
      • -

        isPositive

        -
        public abstract boolean isPositive()
        -
        Tells if the lookup has found a matching template.
        -
      • -
      -
    • -
    -
  • -
-
-
- - - - - - -