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 7294B200D39 for ; Sat, 11 Nov 2017 19:29:30 +0100 (CET) Received: by cust-asf.ponee.io (Postfix) id 70FDE1609E5; Sat, 11 Nov 2017 18:29:30 +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 44413160C08 for ; Sat, 11 Nov 2017 19:29:28 +0100 (CET) Received: (qmail 98850 invoked by uid 500); 11 Nov 2017 18:29:27 -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 98841 invoked by uid 99); 11 Nov 2017 18:29:27 -0000 Received: from pnap-us-west-generic-nat.apache.org (HELO spamd3-us-west.apache.org) (209.188.14.142) by apache.org (qpsmtpd/0.29) with ESMTP; Sat, 11 Nov 2017 18:29:27 +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 7462D191F2B for ; Sat, 11 Nov 2017 18:29:26 +0000 (UTC) X-Virus-Scanned: Debian amavisd-new at spamd3-us-west.apache.org X-Spam-Flag: NO X-Spam-Score: -4.222 X-Spam-Level: X-Spam-Status: No, score=-4.222 tagged_above=-999 required=6.31 tests=[KAM_ASCII_DIVIDERS=0.8, 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 (spamd3-us-west.apache.org [10.40.0.10]) (amavisd-new, port 10024) with ESMTP id bzNREG_Afkhd for ; Sat, 11 Nov 2017 18:29:01 +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 C27D960F88 for ; Sat, 11 Nov 2017 18:28:39 +0000 (UTC) Received: (qmail 95365 invoked by uid 99); 11 Nov 2017 18:28: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; Sat, 11 Nov 2017 18:28:37 +0000 Received: by git1-us-west.apache.org (ASF Mail Server at git1-us-west.apache.org, from userid 33) id 66992F5E10; Sat, 11 Nov 2017 18:28:35 +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: Sat, 11 Nov 2017 18:29:19 -0000 Message-Id: <969a868f3a54492d8e202c6b534ef170@git.apache.org> In-Reply-To: References: X-Mailer: ASF-Git Admin Mailer Subject: [46/51] [partial] incubator-freemarker-site git commit: Site update to use https archived-at: Sat, 11 Nov 2017 18:29:30 -0000 http://git-wip-us.apache.org/repos/asf/incubator-freemarker-site/blob/51c3b7e5/docs/api/freemarker/cache/StringTemplateLoader.html ---------------------------------------------------------------------- diff --git a/docs/api/freemarker/cache/StringTemplateLoader.html b/docs/api/freemarker/cache/StringTemplateLoader.html index b67a67a..d11e44f 100644 --- a/docs/api/freemarker/cache/StringTemplateLoader.html +++ b/docs/api/freemarker/cache/StringTemplateLoader.html @@ -2,10 +2,10 @@ - + StringTemplateLoader (FreeMarker 2.3.27-incubating API) - + @@ -98,7 +98,7 @@ var activeTableTab = "activeTableTab";
    -
  • java.lang.Object
  • +
  • java.lang.Object
    • freemarker.cache.StringTemplateLoader
    • @@ -115,9 +115,9 @@ var activeTableTab = "activeTableTab";

      public class StringTemplateLoader
      -extends Object
      +extends java.lang.Object
       implements TemplateLoader
      -
      A TemplateLoader that uses a Map with String-s as its source of +
      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. @@ -185,54 +185,54 @@ implements void -closeTemplateSource(Object templateSource) +closeTemplateSource(java.lang.Object templateSource)

      Closes the template source, releasing any resources held that are only required for reading the template and/or its metadata.
      -Object -findTemplateSource(String name) +java.lang.Object +findTemplateSource(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.
      long -getLastModified(Object templateSource) +getLastModified(java.lang.Object templateSource)
      Returns the time of last modification of the specified template source.
      -Reader -getReader(Object templateSource, - String encoding) +java.io.Reader +getReader(java.lang.Object templateSource, + java.lang.String encoding)
      Returns the character stream of a template represented by the specified template source.
      void -putTemplate(String name, - String templateContent) +putTemplate(java.lang.String name, + java.lang.String templateContent)
      Puts a template into the loader.
      void -putTemplate(String name, - String templateContent, +putTemplate(java.lang.String name, + java.lang.String templateContent, long lastModified)
      Puts a template into the loader.
      boolean -removeTemplate(String name) +removeTemplate(java.lang.String name)
      Removes the template with the specified name if it was added earlier.
      -String +java.lang.String toString()
      Show class name and some details that are useful in template-not-found errors.
      @@ -242,8 +242,8 @@ implements -

      Methods inherited from class java.lang.Object

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

      Methods inherited from class java.lang.Object

      +clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
@@ -282,8 +282,8 @@ implements
  • putTemplate

    -
    public void putTemplate(String name,
    -                        String templateContent)
    +
    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. @@ -303,8 +303,8 @@ implements
  • putTemplate

    -
    public void putTemplate(String name,
    -                        String templateContent,
    +
    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 @@ -333,7 +333,7 @@ implements
  • removeTemplate

    -
    public boolean removeTemplate(String name)
    +
    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 @@ -354,11 +354,11 @@ implements

  • closeTemplateSource

    -
    public void closeTemplateSource(Object templateSource)
    +
    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 + 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:
    @@ -374,7 +374,7 @@ implements
  • findTemplateSource

    -
    public Object findTemplateSource(String name)
    +
    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.
    @@ -404,10 +404,10 @@ implements 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 + 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 + 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)).
  • @@ -419,7 +419,7 @@ implements
  • getLastModified

    -
    public long getLastModified(Object templateSource)
    +
    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().
    @@ -441,13 +441,13 @@ implements
  • getReader

    -
    public Reader getReader(Object templateSource,
    -                        String encoding)
    +
    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 + 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 + 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.

    @@ -467,8 +467,8 @@ implements 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 +
    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)).
  • @@ -479,11 +479,11 @@ implements
  • toString

    -
    public String toString()
    +
    public java.lang.String toString()
    Show class name and some details that are useful in template-not-found errors.
    Overrides:
    -
    toString in class Object
    +
    toString in class java.lang.Object
    Since:
    2.3.21
    http://git-wip-us.apache.org/repos/asf/incubator-freemarker-site/blob/51c3b7e5/docs/api/freemarker/cache/StrongCacheStorage.html ---------------------------------------------------------------------- diff --git a/docs/api/freemarker/cache/StrongCacheStorage.html b/docs/api/freemarker/cache/StrongCacheStorage.html index 8e14c2c..abee9ce 100644 --- a/docs/api/freemarker/cache/StrongCacheStorage.html +++ b/docs/api/freemarker/cache/StrongCacheStorage.html @@ -2,10 +2,10 @@ - + StrongCacheStorage (FreeMarker 2.3.27-incubating API) - + @@ -98,7 +98,7 @@ var activeTableTab = "activeTableTab";
    • -
    • java.lang.Object
    • +
    • java.lang.Object
      • freemarker.cache.StrongCacheStorage
      • @@ -115,9 +115,9 @@ var activeTableTab = "activeTableTab";

        public class StrongCacheStorage
        -extends Object
        +extends java.lang.Object
         implements ConcurrentCacheStorage, CacheStorageWithGetSize
        -
        Strong cache storage is a cache storage that simply wraps a Map. It holds a strong reference to all objects +
        Strong cache storage is a cache storage that simply wraps a Map. It holds a strong reference to all objects it was passed, therefore prevents the cache from being purged during garbage collection. This class is always thread-safe since 2.3.24, before that if we are running on Java 5 or later.
        @@ -164,8 +164,8 @@ implements clear()  -Object -get(Object key)  +java.lang.Object +get(java.lang.Object key)  int @@ -181,20 +181,20 @@ implements void -put(Object key, - Object value)  +put(java.lang.Object key, + java.lang.Object value)  void -remove(Object key)  +remove(java.lang.Object key) 
      @@ -250,7 +250,7 @@ implements
    • get

      -
      public Object get(Object key)
      +
      public java.lang.Object get(java.lang.Object key)
      Specified by:
      get in interface CacheStorage
      @@ -263,8 +263,8 @@ implements
    • put

      -
      public void put(Object key,
      -                Object value)
      +
      public void put(java.lang.Object key,
      +                java.lang.Object value)
      Specified by:
      put in interface CacheStorage
      @@ -277,7 +277,7 @@ implements
    • remove

      -
      public void remove(Object key)
      +
      public void remove(java.lang.Object key)
      Specified by:
      remove in interface CacheStorage
      http://git-wip-us.apache.org/repos/asf/incubator-freemarker-site/blob/51c3b7e5/docs/api/freemarker/cache/TemplateCache.MaybeMissingTemplate.html ---------------------------------------------------------------------- diff --git a/docs/api/freemarker/cache/TemplateCache.MaybeMissingTemplate.html b/docs/api/freemarker/cache/TemplateCache.MaybeMissingTemplate.html index 2c9ebc7..33d4716 100644 --- a/docs/api/freemarker/cache/TemplateCache.MaybeMissingTemplate.html +++ b/docs/api/freemarker/cache/TemplateCache.MaybeMissingTemplate.html @@ -2,10 +2,10 @@ - + TemplateCache.MaybeMissingTemplate (FreeMarker 2.3.27-incubating API) - + @@ -98,7 +98,7 @@ var activeTableTab = "activeTableTab";
      -
    • java.lang.Object
    • +
    • java.lang.Object
      • freemarker.cache.TemplateCache.MaybeMissingTemplate
      • @@ -115,7 +115,7 @@ var activeTableTab = "activeTableTab";

        public static final class TemplateCache.MaybeMissingTemplate
        -extends Object
        +extends java.lang.Object
    Since:
    @@ -140,13 +140,13 @@ extends Method and Description -String +java.lang.String getMissingTemplateNormalizedName()
    When the template was missing, this possibly contains its normalized name.
    -String +java.lang.String getMissingTemplateReason()
    When the template was missing, this possibly contains the explanation, or null.
    @@ -162,8 +162,8 @@ extends -

    Methods inherited from class java.lang.Object

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

    Methods inherited from class java.lang.Object

    +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait @@ -195,7 +195,7 @@ extends
  • getMissingTemplateReason

    -
    public String getMissingTemplateReason()
    +
    public java.lang.String getMissingTemplateReason()
    When the template was missing, this possibly contains the explanation, or null. If the template wasn't missing (i.e., when getTemplate() return non-null) this is always null.
    @@ -207,7 +207,7 @@ extends
  • getMissingTemplateNormalizedName

    -
    public String getMissingTemplateNormalizedName()
    +
    public java.lang.String getMissingTemplateNormalizedName()
    When the template was missing, this possibly contains its normalized name. If the template wasn't missing (i.e., when getTemplate() return non-null) this is always null. When the template is missing, it will be null for example if the normalization itself was unsuccessful.
    http://git-wip-us.apache.org/repos/asf/incubator-freemarker-site/blob/51c3b7e5/docs/api/freemarker/cache/TemplateCache.html ---------------------------------------------------------------------- diff --git a/docs/api/freemarker/cache/TemplateCache.html b/docs/api/freemarker/cache/TemplateCache.html index c83c974..9b77eb4 100644 --- a/docs/api/freemarker/cache/TemplateCache.html +++ b/docs/api/freemarker/cache/TemplateCache.html @@ -2,10 +2,10 @@ - + TemplateCache (FreeMarker 2.3.27-incubating API) - + @@ -98,7 +98,7 @@ var activeTableTab = "activeTableTab";
  • @@ -429,7 +429,7 @@ extends
  • TemplateCache

    -
    @Deprecated
    +
    @Deprecated
     public TemplateCache()
    Deprecated. Use TemplateCache(TemplateLoader) instead. The default loader is useless in most applications, also it can mean a security risk.
    @@ -444,7 +444,7 @@ public TemplateCache()
    @@ -557,7 +557,7 @@ public TemplateCache(
  • setConfiguration

    -
    @Deprecated
    +
    @Deprecated
     public void setConfiguration(Configuration config)
    Sets the configuration object to which this cache belongs. This @@ -628,12 +628,12 @@ public void setConfiguration(
  • getTemplate

    -
    public TemplateCache.MaybeMissingTemplate getTemplate(String name,
    -                                                      Locale locale,
    -                                                      Object customLookupCondition,
    -                                                      String encoding,
    +
    public TemplateCache.MaybeMissingTemplate getTemplate(java.lang.String name,
    +                                                      java.util.Locale locale,
    +                                                      java.lang.Object customLookupCondition,
    +                                                      java.lang.String encoding,
                                                           boolean parseAsFTL)
    -                                               throws IOException
    + throws java.io.IOException
    Retrieves the template with the given name (and according the specified further parameters) from the template cache, loading it into the cache first if it's missing/staled. @@ -655,7 +655,7 @@ public void setConfiguration(Configuration.getIncompatibleImprovements() is less than 2.4.0, then instead of throwing this exception, a TemplateCache.MaybeMissingTemplate will be returned, similarly as if the template were missing (the TemplateCache.MaybeMissingTemplate.getMissingTemplateReason() will describe the real error). -
    IOException - If reading the template has failed from a reason other than the template is missing. This method +
    java.io.IOException - If reading the template has failed from a reason other than the template is missing. This method should never be a TemplateNotFoundException, as that condition is indicated in the return value.
    Since:
    @@ -669,12 +669,12 @@ public void setConfiguration(
  • getTemplate

    -
    @Deprecated
    -public Template getTemplate(String name,
    -                                        Locale locale,
    -                                        String encoding,
    -                                        boolean parseAsFTL)
    -                                 throws IOException
    +
    @Deprecated
    +public Template getTemplate(java.lang.String name,
    +                                         java.util.Locale locale,
    +                                         java.lang.String encoding,
    +                                         boolean parseAsFTL)
    +                                  throws java.io.IOException
    Deprecated. Use getTemplate(String, Locale, Object, String, boolean), which can return more detailed result when the template is missing.
  • @@ -694,7 +694,7 @@ public 
  • createLegacyDefaultTemplateLoader

    -
    @Deprecated
    +
    @Deprecated
     protected static TemplateLoader createLegacyDefaultTemplateLoader()
    Deprecated. The TemplateLoader should be always specified by the constructor caller.
    Returns the deprecated default template loader of FreeMarker 2.3.0.
    @@ -770,16 +770,16 @@ protected static 
  • removeTemplate

    -
    public void removeTemplate(String name,
    -                           Locale locale,
    -                           String encoding,
    +
    public void removeTemplate(java.lang.String name,
    +                           java.util.Locale locale,
    +                           java.lang.String encoding,
                                boolean parse)
    -                    throws IOException
    + throws java.io.IOException
    Same as removeTemplate(String, Locale, Object, String, boolean) with null customLookupCondition.
    Throws:
    -
    IOException
    +
    java.io.IOException
  • @@ -789,12 +789,12 @@ protected static 
  • removeTemplate

    -
    public void removeTemplate(String name,
    -                           Locale locale,
    -                           Object customLookupCondition,
    -                           String encoding,
    +
    public void removeTemplate(java.lang.String name,
    +                           java.util.Locale locale,
    +                           java.lang.Object customLookupCondition,
    +                           java.lang.String encoding,
                                boolean parse)
    -                    throws IOException
    + throws java.io.IOException
    Removes an entry from the cache, hence forcing the re-loading of it when it's next time requested. (It doesn't delete the template file itself.) This is to give the application finer control over cache updating than setDelay(long) alone does. @@ -803,7 +803,7 @@ protected static Configuration.getTemplate(String, Locale, Object, String, boolean, boolean)
    Throws:
    -
    IOException
    +
    java.io.IOException
  • @@ -813,15 +813,15 @@ protected static 
  • getFullTemplatePath

    -
    @Deprecated
    -public static String getFullTemplatePath(Environment env,
    -                                                     String baseName,
    -                                                     String targetName)
    +
    @Deprecated
    +public static java.lang.String getFullTemplatePath(Environment env,
    +                                                                java.lang.String baseName,
    +                                                                java.lang.String targetName)
    Deprecated. Use Environment.toFullTemplateName(String, String) instead, as that can throw MalformedTemplateNameException, and is on a more logical place anyway.
    Throws:
    -
    IllegalArgumentException - If the baseName or targetName is malformed according the TemplateNameFormat +
    java.lang.IllegalArgumentException - If the baseName or targetName is malformed according the TemplateNameFormat in use.
  • http://git-wip-us.apache.org/repos/asf/incubator-freemarker-site/blob/51c3b7e5/docs/api/freemarker/cache/TemplateConfigurationFactory.html ---------------------------------------------------------------------- diff --git a/docs/api/freemarker/cache/TemplateConfigurationFactory.html b/docs/api/freemarker/cache/TemplateConfigurationFactory.html index d055a00..c8b63a5 100644 --- a/docs/api/freemarker/cache/TemplateConfigurationFactory.html +++ b/docs/api/freemarker/cache/TemplateConfigurationFactory.html @@ -2,10 +2,10 @@ - + TemplateConfigurationFactory (FreeMarker 2.3.27-incubating API) - + @@ -98,7 +98,7 @@ var activeTableTab = "activeTableTab";
    • -
    • java.lang.Object
    • +
    • java.lang.Object
      • freemarker.cache.TemplateConfigurationFactory
      • @@ -115,7 +115,7 @@ var activeTableTab = "activeTableTab";

        public abstract class TemplateConfigurationFactory
        -extends Object
        +extends java.lang.Object
    Creates (or returns) TemplateConfiguration-s for template sources.
    Since:
    @@ -158,8 +158,8 @@ extends abstract TemplateConfiguration -get(String sourceName, - Object templateSource) +get(java.lang.String sourceName, + java.lang.Object templateSource)
    Returns (maybe creates) the TemplateConfiguration for the given template source.
    @@ -189,8 +189,8 @@ extends -

    Methods inherited from class java.lang.Object

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

    Methods inherited from class java.lang.Object

    +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait @@ -229,9 +229,9 @@ extends
  • get

    -
    public abstract TemplateConfiguration get(String sourceName,
    -                                          Object templateSource)
    -                                   throws IOException,
    +
    public abstract TemplateConfiguration get(java.lang.String sourceName,
    +                                          java.lang.Object templateSource)
    +                                   throws java.io.IOException,
                                               TemplateConfigurationFactoryException
    Returns (maybe creates) the TemplateConfiguration for the given template source.
    @@ -243,7 +243,7 @@ extends TemplateConfiguration to apply, or null if the there's no TemplateConfiguration for this template source.
    Throws:
    -
    IOException - Typically, if there factory needs further I/O to find out more about the template source, but that +
    java.io.IOException - Typically, if there factory needs further I/O to find out more about the template source, but that fails.
    TemplateConfigurationFactoryException - If there's a problem that's specific to the factory logic.