From notifications-return-5477-archive-asf-public=cust-asf.ponee.io@freemarker.apache.org Fri Mar 30 23:44:06 2018 Return-Path: X-Original-To: archive-asf-public@cust-asf.ponee.io Delivered-To: archive-asf-public@cust-asf.ponee.io Received: from mail.apache.org (hermes.apache.org [140.211.11.3]) by mx-eu-01.ponee.io (Postfix) with SMTP id 77CBC1807FD for ; Fri, 30 Mar 2018 23:43:58 +0200 (CEST) Received: (qmail 81215 invoked by uid 500); 30 Mar 2018 21:43:57 -0000 Mailing-List: contact notifications-help@freemarker.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: dev@freemarker.apache.org Delivered-To: mailing list notifications@freemarker.apache.org Received: (qmail 80664 invoked by uid 99); 30 Mar 2018 21:43:56 -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, 30 Mar 2018 21:43:56 +0000 Received: by git1-us-west.apache.org (ASF Mail Server at git1-us-west.apache.org, from userid 33) id 05BB4F6A8B; Fri, 30 Mar 2018 21:43:55 +0000 (UTC) Content-Type: text/plain; charset="us-ascii" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit From: ddekany@apache.org To: notifications@freemarker.apache.org Date: Fri, 30 Mar 2018 21:44:35 -0000 Message-Id: <8ff7c63255d94394b90c38792c89b8d5@git.apache.org> In-Reply-To: References: X-Mailer: ASF-Git Admin Mailer Subject: [42/51] [partial] freemarker-site git commit: Deleted snapshot documentation http://git-wip-us.apache.org/repos/asf/freemarker-site/blob/fb8636c4/builds/fm2.3.28/api/freemarker/cache/PathRegexMatcher.html ---------------------------------------------------------------------- diff --git a/builds/fm2.3.28/api/freemarker/cache/PathRegexMatcher.html b/builds/fm2.3.28/api/freemarker/cache/PathRegexMatcher.html deleted file mode 100644 index 5f0ce4d..0000000 --- a/builds/fm2.3.28/api/freemarker/cache/PathRegexMatcher.html +++ /dev/null @@ -1,296 +0,0 @@ - - - - - - -PathRegexMatcher (FreeMarker 2.3.28-nightly_20180310T195428Z-incubating API) - - - - - - - - - - - - -
-
freemarker.cache
-

Class PathRegexMatcher

-
-
- -
-
    -
  • -
    -
    -
    public class PathRegexMatcher
    -extends TemplateSourceMatcher
    -
    Matches the whole template source name (also known as template source path) with the given regular expression. - Note that the template source name is relative to the template storage root defined by the TemplateLoader; - it's not the full path of a file on the file system.
    -
    -
    Since:
    -
    2.3.24
    -
    -
  • -
-
-
-
    -
  • - -
      -
    • - - -

      Constructor Summary

      - - - - - - - - -
      Constructors 
      Constructor and Description
      PathRegexMatcher(java.lang.String regex) 
      -
    • -
    - -
      -
    • - - -

      Method Summary

      - - - - - - - - - - -
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      booleanmatches(java.lang.String sourceName, - java.lang.Object templateSource) 
      -
        -
      • - - -

        Methods inherited from class java.lang.Object

        -clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
      • -
      -
    • -
    -
  • -
-
-
-
    -
  • - - - -
      -
    • - - -

      Method Detail

      - - - -
        -
      • -

        matches

        -
        public boolean matches(java.lang.String sourceName,
        -                       java.lang.Object templateSource)
        -                throws java.io.IOException
        -
        -
        Throws:
        -
        java.io.IOException
        -
        -
      • -
      -
    • -
    -
  • -
-
-
- - - - - - - http://git-wip-us.apache.org/repos/asf/freemarker-site/blob/fb8636c4/builds/fm2.3.28/api/freemarker/cache/SoftCacheStorage.html ---------------------------------------------------------------------- diff --git a/builds/fm2.3.28/api/freemarker/cache/SoftCacheStorage.html b/builds/fm2.3.28/api/freemarker/cache/SoftCacheStorage.html deleted file mode 100644 index 9e5efe4..0000000 --- a/builds/fm2.3.28/api/freemarker/cache/SoftCacheStorage.html +++ /dev/null @@ -1,402 +0,0 @@ - - - - - - -SoftCacheStorage (FreeMarker 2.3.28-nightly_20180310T195428Z-incubating API) - - - - - - - - - - - - -
-
freemarker.cache
-

Class SoftCacheStorage

-
-
-
    -
  • java.lang.Object
  • -
  • -
      -
    • freemarker.cache.SoftCacheStorage
    • -
    -
  • -
-
- -
-
-
    -
  • - -
      -
    • - - -

      Constructor Summary

      - - - - - - - - - - - -
      Constructors 
      Constructor and Description
      SoftCacheStorage() -
      Creates an instance that uses a ConcurrentMap internally.
      -
      SoftCacheStorage(java.util.Map backingMap) 
      -
    • -
    - -
      -
    • - - -

      Method Summary

      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      voidclear() 
      java.lang.Objectget(java.lang.Object key) 
      intgetSize() -
      Returns a close approximation of the number of cache entries.
      -
      booleanisConcurrent() -
      Returns true if the underlying Map is a ConcurrentMap.
      -
      voidput(java.lang.Object key, - java.lang.Object value) 
      voidremove(java.lang.Object key) 
      -
        -
      • - - -

        Methods inherited from class java.lang.Object

        -clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
      • -
      -
    • -
    -
  • -
-
-
-
    -
  • - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        SoftCacheStorage

        -
        public SoftCacheStorage()
        -
        Creates an instance that uses a ConcurrentMap internally.
        -
      • -
      - - - -
        -
      • -

        SoftCacheStorage

        -
        public SoftCacheStorage(java.util.Map backingMap)
        -
      • -
      -
    • -
    - -
      -
    • - - -

      Method Detail

      - - - -
        -
      • -

        isConcurrent

        -
        public boolean isConcurrent()
        -
        Returns true if the underlying Map is a ConcurrentMap.
        -
        -
        Specified by:
        -
        isConcurrent in interface ConcurrentCacheStorage
        -
        Returns:
        -
        true if this instance of cache storage is concurrently - accessible from multiple threads without synchronization.
        -
        -
      • -
      - - - -
        -
      • -

        get

        -
        public java.lang.Object get(java.lang.Object key)
        -
        -
        Specified by:
        -
        get in interface CacheStorage
        -
        -
      • -
      - - - -
        -
      • -

        put

        -
        public void put(java.lang.Object key,
        -                java.lang.Object value)
        -
        -
        Specified by:
        -
        put in interface CacheStorage
        -
        -
      • -
      - - - -
        -
      • -

        remove

        -
        public void remove(java.lang.Object key)
        -
        -
        Specified by:
        -
        remove in interface CacheStorage
        -
        -
      • -
      - - - -
        -
      • -

        clear

        -
        public void clear()
        -
        -
        Specified by:
        -
        clear in interface CacheStorage
        -
        -
      • -
      - - - -
        -
      • -

        getSize

        -
        public int getSize()
        -
        Returns a close approximation of the number of cache entries.
        -
        -
        Specified by:
        -
        getSize in interface CacheStorageWithGetSize
        -
        Since:
        -
        2.3.21
        -
        -
      • -
      -
    • -
    -
  • -
-
-
- - - - - - - http://git-wip-us.apache.org/repos/asf/freemarker-site/blob/fb8636c4/builds/fm2.3.28/api/freemarker/cache/StatefulTemplateLoader.html ---------------------------------------------------------------------- diff --git a/builds/fm2.3.28/api/freemarker/cache/StatefulTemplateLoader.html b/builds/fm2.3.28/api/freemarker/cache/StatefulTemplateLoader.html deleted file mode 100644 index 3d00d22..0000000 --- a/builds/fm2.3.28/api/freemarker/cache/StatefulTemplateLoader.html +++ /dev/null @@ -1,246 +0,0 @@ - - - - - - -StatefulTemplateLoader (FreeMarker 2.3.28-nightly_20180310T195428Z-incubating API) - - - - - - - - - - - - -
-
freemarker.cache
-

Interface StatefulTemplateLoader

-
-
-
-
    -
  • -
    -
    All Superinterfaces:
    -
    TemplateLoader
    -
    -
    -
    All Known Implementing Classes:
    -
    MultiTemplateLoader
    -
    -
    -
    -
    public interface StatefulTemplateLoader
    -extends TemplateLoader
    -
    Interface that can be implemented by TemplateLoader-s that maintain some - sort of internal state (i.e. caches of earlier lookups for performance - optimization purposes etc.) and support resetting of their state.
    -
  • -
-
-
- -
-
-
    -
  • - - -
  • -
-
-
- - - - - - - http://git-wip-us.apache.org/repos/asf/freemarker-site/blob/fb8636c4/builds/fm2.3.28/api/freemarker/cache/StringTemplateLoader.html ---------------------------------------------------------------------- diff --git a/builds/fm2.3.28/api/freemarker/cache/StringTemplateLoader.html b/builds/fm2.3.28/api/freemarker/cache/StringTemplateLoader.html deleted file mode 100644 index ed2f919..0000000 --- a/builds/fm2.3.28/api/freemarker/cache/StringTemplateLoader.html +++ /dev/null @@ -1,562 +0,0 @@ - - - - - - -StringTemplateLoader (FreeMarker 2.3.28-nightly_20180310T195428Z-incubating API) - - - - - - - - - - - - -
-
freemarker.cache
-

Class StringTemplateLoader

-
-
-
    -
  • java.lang.Object
  • -
  • -
      -
    • freemarker.cache.StringTemplateLoader
    • -
    -
  • -
-
-
    -
  • -
    -
    All Implemented Interfaces:
    -
    TemplateLoader
    -
    -
    -
    -
    public class StringTemplateLoader
    -extends java.lang.Object
    -implements TemplateLoader
    -
    A TemplateLoader that uses a Map with String-s as its source of - templates. - -

    In most case the regular way of loading templates from files will be fine. - However, there can be situations where you don't want to or can't load a - template from a file, e.g. if you have to deploy a single jar for - JavaWebStart or if they are contained within a database. - A single template can be created manually - e.g. -

    -   String templateStr="Hello ${user}";
    -   Template t = new Template("name", new StringReader(templateStr),
    -               new Configuration());
    - 
    -

    If, however, you want to create templates from strings which import other - templates this method doesn't work. - -

    In that case you can create a StringTemplateLoader and add each template to - it: -

    -   StringTemplateLoader stringLoader = new StringTemplateLoader();
    -   stringLoader.putTemplate("greetTemplate", "<#macro greet>Hello</#macro>");
    -   stringLoader.putTemplate("myTemplate", "<#include \"greetTemplate\"><@greet/> World!");
    - 
    -

    Then you tell your Configuration object to use it: -

    -   cfg.setTemplateLoader(stringLoader);
    - 
    -

    After that you should be able to use the templates as usual. Often you will - want to combine a StringTemplateLoader with another loader. You can - do so using a MultiTemplateLoader.

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

      Method Summary

      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      voidcloseTemplateSource(java.lang.Object templateSource) -
      Closes the template source, releasing any resources held that are only required for reading the template and/or - its metadata.
      -
      java.lang.ObjectfindTemplateSource(java.lang.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(java.lang.Object templateSource) -
      Returns the time of last modification of the specified template source.
      -
      java.io.ReadergetReader(java.lang.Object templateSource, - java.lang.String encoding) -
      Returns the character stream of a template represented by the specified template source.
      -
      voidputTemplate(java.lang.String name, - java.lang.String templateContent) -
      Puts a template into the loader.
      -
      voidputTemplate(java.lang.String name, - java.lang.String templateContent, - long lastModified) -
      Puts a template into the loader.
      -
      booleanremoveTemplate(java.lang.String name) -
      Removes the template with the specified name if it was added earlier.
      -
      java.lang.StringtoString() -
      Show class name and some details that are useful in template-not-found errors.
      -
      -
        -
      • - - -

        Methods inherited from class java.lang.Object

        -clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
      • -
      -
    • -
    -
  • -
-
-
-
    -
  • - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        StringTemplateLoader

        -
        public StringTemplateLoader()
        -
      • -
      -
    • -
    - -
      -
    • - - -

      Method Detail

      - - - -
        -
      • -

        putTemplate

        -
        public void putTemplate(java.lang.String name,
        -                        java.lang.String templateContent)
        -
        Puts a template into the loader. A call to this method is identical to - the call to the three-arg putTemplate(String, String, long) - passing System.currentTimeMillis() as the third argument. - -

        Note that this method is not thread safe! Don't call it after FreeMarker has started using this template - loader.

        -
        -
        Parameters:
        -
        name - the name of the template.
        -
        templateContent - the source code of the template.
        -
        -
      • -
      - - - -
        -
      • -

        putTemplate

        -
        public void putTemplate(java.lang.String name,
        -                        java.lang.String templateContent,
        -                        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. - -

        Note that this method is not thread safe! Don't call it after FreeMarker has started using this template - loader.

        -
        -
        Parameters:
        -
        name - the name of the template.
        -
        templateContent - the source code of the template.
        -
        lastModified - the time of last modification of the template in - terms of System.currentTimeMillis()
        -
        -
      • -
      - - - -
        -
      • -

        removeTemplate

        -
        public boolean removeTemplate(java.lang.String name)
        -
        Removes the template with the specified name if it was added earlier. - -

        Note that this method is not thread safe! Don't call it after FreeMarker has started using this template - loader.

        -
        -
        Parameters:
        -
        name - Exactly the key with which the template was added.
        -
        Returns:
        -
        Whether a template was found with the given key (and hence was removed now)
        -
        Since:
        -
        2.3.24
        -
        -
      • -
      - - - -
        -
      • -

        closeTemplateSource

        -
        public void closeTemplateSource(java.lang.Object templateSource)
        -
        Description copied from interface: TemplateLoader
        -
        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 TemplateLoader.findTemplateSource(String).
        -
        -
        Specified by:
        -
        closeTemplateSource in interface TemplateLoader
        -
        Parameters:
        -
        templateSource - the template source that should be closed.
        -
        -
      • -
      - - - -
        -
      • -

        findTemplateSource

        -
        public java.lang.Object findTemplateSource(java.lang.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 (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 - 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(java.lang.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 java.io.Reader getReader(java.lang.Object templateSource,
        -                                java.lang.String encoding)
        -
        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)).
        -
        -
      • -
      - - - -
        -
      • -

        toString

        -
        public java.lang.String toString()
        -
        Show class name and some details that are useful in template-not-found errors.
        -
        -
        Overrides:
        -
        toString in class java.lang.Object
        -
        Since:
        -
        2.3.21
        -
        -
      • -
      -
    • -
    -
  • -
-
-
- - - - - - - http://git-wip-us.apache.org/repos/asf/freemarker-site/blob/fb8636c4/builds/fm2.3.28/api/freemarker/cache/StrongCacheStorage.html ---------------------------------------------------------------------- diff --git a/builds/fm2.3.28/api/freemarker/cache/StrongCacheStorage.html b/builds/fm2.3.28/api/freemarker/cache/StrongCacheStorage.html deleted file mode 100644 index 889364e..0000000 --- a/builds/fm2.3.28/api/freemarker/cache/StrongCacheStorage.html +++ /dev/null @@ -1,386 +0,0 @@ - - - - - - -StrongCacheStorage (FreeMarker 2.3.28-nightly_20180310T195428Z-incubating API) - - - - - - - - - - - - -
-
freemarker.cache
-

Class StrongCacheStorage

-
-
-
    -
  • java.lang.Object
  • -
  • -
      -
    • freemarker.cache.StrongCacheStorage
    • -
    -
  • -
-
- -
-
-
    -
  • - -
      -
    • - - -

      Constructor Summary

      - - - - - - - - -
      Constructors 
      Constructor and Description
      StrongCacheStorage() 
      -
    • -
    - -
      -
    • - - -

      Method Summary

      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      voidclear() 
      java.lang.Objectget(java.lang.Object key) 
      intgetSize() -
      Returns a close approximation of the number of cache entries.
      -
      booleanisConcurrent() -
      Always returns true.
      -
      voidput(java.lang.Object key, - java.lang.Object value) 
      voidremove(java.lang.Object key) 
      -
        -
      • - - -

        Methods inherited from class java.lang.Object

        -clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
      • -
      -
    • -
    -
  • -
-
-
-
    -
  • - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        StrongCacheStorage

        -
        public StrongCacheStorage()
        -
      • -
      -
    • -
    - -
      -
    • - - -

      Method Detail

      - - - -
        -
      • -

        isConcurrent

        -
        public boolean isConcurrent()
        -
        Always returns true.
        -
        -
        Specified by:
        -
        isConcurrent in interface ConcurrentCacheStorage
        -
        Returns:
        -
        true if this instance of cache storage is concurrently - accessible from multiple threads without synchronization.
        -
        -
      • -
      - - - -
        -
      • -

        get

        -
        public java.lang.Object get(java.lang.Object key)
        -
        -
        Specified by:
        -
        get in interface CacheStorage
        -
        -
      • -
      - - - -
        -
      • -

        put

        -
        public void put(java.lang.Object key,
        -                java.lang.Object value)
        -
        -
        Specified by:
        -
        put in interface CacheStorage
        -
        -
      • -
      - - - -
        -
      • -

        remove

        -
        public void remove(java.lang.Object key)
        -
        -
        Specified by:
        -
        remove in interface CacheStorage
        -
        -
      • -
      - - - -
        -
      • -

        getSize

        -
        public int getSize()
        -
        Returns a close approximation of the number of cache entries.
        -
        -
        Specified by:
        -
        getSize in interface CacheStorageWithGetSize
        -
        Since:
        -
        2.3.21
        -
        -
      • -
      - - - -
        -
      • -

        clear

        -
        public void clear()
        -
        -
        Specified by:
        -
        clear in interface CacheStorage
        -
        -
      • -
      -
    • -
    -
  • -
-
-
- - - - - - -