Author: cbrisson
Date: Tue Jan 3 17:48:02 2017
New Revision: 1777180
URL: http://svn.apache.org/viewvc?rev=1777180&view=rev
Log:
[site/engine] document events API change in upgrading page (devel & 2.0) =>
into production
Modified:
velocity/site/production/engine/2.0/upgrading.html
velocity/site/production/engine/devel/upgrading.html
Modified: velocity/site/production/engine/2.0/upgrading.html
URL:
http://svn.apache.org/viewvc/velocity/site/production/engine/2.0/upgrading.html?rev=1777180&r1=1777179&r2=1777180&view=diff
==============================================================================
--- velocity/site/production/engine/2.0/upgrading.html (original)
+++ velocity/site/production/engine/2.0/upgrading.html Tue Jan 3 17:48:02 2017
@@ -238,13 +238,13 @@ space.gobbling = bc
<ul>
<li>velocity is now using the SLF4J logging facade. Hence, all methods
accepting or returning a logger now use the org.slf4j.Logger object. Velocity
uses a logger name of <code>org.apache.velocity</code> (configurable with the
<code>runtime.log.name</code> configuration entry), and <a
href="developer-guide.html#logging">several other childen loggers</a>.</li>
<li>the internal Context API now enforces String keys everywhere, this may
break custom Context implementations at compile-time.</li>
-<li>invalid reference events are now more sparsely sent; they're not sent if
<em>any</em> of the following conditions is met:<ul>
+<li>invalid reference events are now more sparsely sent; they're not sent if
<em>any</em> of the following conditions is met (the 1.x behavior did send
invalid reference events in all those cases):<ul>
<li>the reference is a quiet reference</li>
<li>the reference could be successfully evaluated but resulted in a null
value</li>
-<li>the reference is tested for validity inside an #if / #elseif statement
-The 1.x behavior did send invalid reference events in all those cases.</li>
+<li>the reference is tested for validity inside an #if / #elseif statement</li>
</ul>
</li>
+<li>all events do now receive the current Velocity Context as a first
argument. The signatures of the <code>MethodExceptionEventHandler</code>,
<code>ReferenceInsertionEventHandler</code> and
<code>IncludeEventHandler</code> events have changed, and the
<code>ContextAware</code> interface has been suppressed, as long as the
<code>NullSetEventHandler</code> event which is obsolete.</li>
<li>The <code>ResourceLoader</code> class API has replaced InputStream getters
by Reader getters: <code>InputStream ResourceLoader.getResourceStream(String
name)</code> has been replaced by a <code>Reader
ResourceLoader.getResourceReader(String name, String encoding)</code>.</li>
<li>the default encoding ('ISO-8859-1' in 1.x) is now UTF-8.</li>
<li>the MethodException event handler now receives an additional argument
providing template name and location infos.</li>
Modified: velocity/site/production/engine/devel/upgrading.html
URL:
http://svn.apache.org/viewvc/velocity/site/production/engine/devel/upgrading.html?rev=1777180&r1=1777179&r2=1777180&view=diff
==============================================================================
--- velocity/site/production/engine/devel/upgrading.html (original)
+++ velocity/site/production/engine/devel/upgrading.html Tue Jan 3 17:48:02
2017
@@ -238,13 +238,13 @@ space.gobbling = bc
<ul>
<li>velocity is now using the SLF4J logging facade. Hence, all methods
accepting or returning a logger now use the org.slf4j.Logger object. Velocity
uses a logger name of <code>org.apache.velocity</code> (configurable with the
<code>runtime.log.name</code> configuration entry), and <a
href="developer-guide.html#logging">several other childen loggers</a>.</li>
<li>the internal Context API now enforces String keys everywhere, this may
break custom Context implementations at compile-time.</li>
-<li>invalid reference events are now more sparsely sent; they're not sent if
<em>any</em> of the following conditions is met:<ul>
+<li>invalid reference events are now more sparsely sent; they're not sent if
<em>any</em> of the following conditions is met (the 1.x behavior did send
invalid reference events in all those cases):<ul>
<li>the reference is a quiet reference</li>
<li>the reference could be successfully evaluated but resulted in a null
value</li>
-<li>the reference is tested for validity inside an #if / #elseif statement
-The 1.x behavior did send invalid reference events in all those cases.</li>
+<li>the reference is tested for validity inside an #if / #elseif statement</li>
</ul>
</li>
+<li>all events do now receive the current Velocity Context as a first
argument. The signatures of the <code>MethodExceptionEventHandler</code>,
<code>ReferenceInsertionEventHandler</code> and
<code>IncludeEventHandler</code> events have changed, and the
<code>ContextAware</code> interface has been suppressed, as long as the
<code>NullSetEventHandler</code> event which is obsolete.</li>
<li>The <code>ResourceLoader</code> class API has replaced InputStream getters
by Reader getters: <code>InputStream ResourceLoader.getResourceStream(String
name)</code> has been replaced by a <code>Reader
ResourceLoader.getResourceReader(String name, String encoding)</code>.</li>
<li>the default encoding ('ISO-8859-1' in 1.x) is now UTF-8.</li>
<li>the MethodException event handler now receives an additional argument
providing template name and location infos.</li>
