Repository: freemarker Updated Branches: refs/heads/2.3-gae 4ce3e635c -> 42450882c
Better JavaDoc for getLastModified Project: http://git-wip-us.apache.org/repos/asf/freemarker/repo Commit: http://git-wip-us.apache.org/repos/asf/freemarker/commit/42450882 Tree: http://git-wip-us.apache.org/repos/asf/freemarker/tree/42450882 Diff: http://git-wip-us.apache.org/repos/asf/freemarker/diff/42450882 Branch: refs/heads/2.3-gae Commit: 42450882c09ec6c5f087a117f1431ee7bf309b23 Parents: 4ce3e63 Author: ddekany <[email protected]> Authored: Thu Oct 18 21:19:03 2018 +0200 Committer: ddekany <[email protected]> Committed: Thu Oct 18 21:21:14 2018 +0200 ---------------------------------------------------------------------- src/main/java/freemarker/cache/TemplateLoader.java | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/freemarker/blob/42450882/src/main/java/freemarker/cache/TemplateLoader.java ---------------------------------------------------------------------- diff --git a/src/main/java/freemarker/cache/TemplateLoader.java b/src/main/java/freemarker/cache/TemplateLoader.java index ebbcd9d..9b837dc 100644 --- a/src/main/java/freemarker/cache/TemplateLoader.java +++ b/src/main/java/freemarker/cache/TemplateLoader.java @@ -96,10 +96,15 @@ public interface TemplateLoader { * <code>findTemplateSource()</code>. * * @param templateSource - * an object representing a template source, obtained through a prior call to + * an object representing a template source (the template file), obtained through a prior call to * {@link #findTemplateSource(String)}. This must be an object on which * {@link TemplateLoader#closeTemplateSource(Object)} wasn't applied yet. - * @return the time of last modification of the specified template source, or -1 if the time is not known. + * @return The time of last modification for the specified template source, or -1 if the time is not known. This + * value meant to be milliseconds since the epoch, but in fact FreeMarker doesn't care what it means, it + * only cares if it changes, in which case the template needs to be reloaded (even if the value has + * decreased). -1 is not special in that regard either; if you keep returning it, FreeMarker won't + * reload the template (as far as it's not evicted from the cache from some other + * reason). Note that {@link Long#MIN_VALUE} is reserved for internal use. */ public long getLastModified(Object templateSource);
