Author: cbrisson
Date: Tue Jan 3 17:47:31 2017
New Revision: 1777177
URL: http://svn.apache.org/viewvc?rev=1777177&view=rev
Log:
[site/engine] document events API change in upgrading page (devel & 2.0)
Modified:
velocity/site/cms/trunk/content/engine/2.0/upgrading.mdtext
velocity/site/cms/trunk/content/engine/devel/upgrading.mdtext
Modified: velocity/site/cms/trunk/content/engine/2.0/upgrading.mdtext
URL:
http://svn.apache.org/viewvc/velocity/site/cms/trunk/content/engine/2.0/upgrading.mdtext?rev=1777177&r1=1777176&r2=1777177&view=diff
==============================================================================
--- velocity/site/cms/trunk/content/engine/2.0/upgrading.mdtext (original)
+++ velocity/site/cms/trunk/content/engine/2.0/upgrading.mdtext Tue Jan 3
17:47:31 2017
@@ -19,11 +19,11 @@ Read below for futher details.
+ 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 `org.apache.velocity` (configurable with the `runtime.log.name`
configuration entry), and [several other childen
loggers](developer-guide.html#logging).
+ the internal Context API now enforces String keys everywhere, this may break
custom Context implementations at compile-time.
-+ invalid reference events are now more sparsely sent; they're not sent if
*any* of the following conditions is met:
++ invalid reference events are now more sparsely sent; they're not sent if
*any* of the following conditions is met (the 1.x behavior did send invalid
reference events in all those cases):
+ the reference is a quiet reference
+ the reference could be successfully evaluated but resulted in a null
value
+ the reference is tested for validity inside an #if / #elseif statement
- The 1.x behavior did send invalid reference events in all those cases.
++ all events do now receive the current Velocity Context as a first argument.
The signatures of the `MethodExceptionEventHandler`,
`ReferenceInsertionEventHandler` and `IncludeEventHandler` events have changed,
and the `ContextAware` interface has been suppressed, as long as the
`NullSetEventHandler` event which is obsolete.
+ The `ResourceLoader` class API has replaced InputStream getters by Reader
getters: `InputStream ResourceLoader.getResourceStream(String name)` has been
replaced by a `Reader ResourceLoader.getResourceReader(String name, String
encoding)`.
+ the default encoding ('ISO-8859-1' in 1.x) is now UTF-8.
+ the MethodException event handler now receives an additional argument
providing template name and location infos.
Modified: velocity/site/cms/trunk/content/engine/devel/upgrading.mdtext
URL:
http://svn.apache.org/viewvc/velocity/site/cms/trunk/content/engine/devel/upgrading.mdtext?rev=1777177&r1=1777176&r2=1777177&view=diff
==============================================================================
--- velocity/site/cms/trunk/content/engine/devel/upgrading.mdtext (original)
+++ velocity/site/cms/trunk/content/engine/devel/upgrading.mdtext Tue Jan 3
17:47:31 2017
@@ -19,11 +19,11 @@ Read below for futher details.
+ 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 `org.apache.velocity` (configurable with the `runtime.log.name`
configuration entry), and [several other childen
loggers](developer-guide.html#logging).
+ the internal Context API now enforces String keys everywhere, this may break
custom Context implementations at compile-time.
-+ invalid reference events are now more sparsely sent; they're not sent if
*any* of the following conditions is met:
++ invalid reference events are now more sparsely sent; they're not sent if
*any* of the following conditions is met (the 1.x behavior did send invalid
reference events in all those cases):
+ the reference is a quiet reference
+ the reference could be successfully evaluated but resulted in a null
value
+ the reference is tested for validity inside an #if / #elseif statement
- The 1.x behavior did send invalid reference events in all those cases.
++ all events do now receive the current Velocity Context as a first argument.
The signatures of the `MethodExceptionEventHandler`,
`ReferenceInsertionEventHandler` and `IncludeEventHandler` events have changed,
and the `ContextAware` interface has been suppressed, as long as the
`NullSetEventHandler` event which is obsolete.
+ The `ResourceLoader` class API has replaced InputStream getters by Reader
getters: `InputStream ResourceLoader.getResourceStream(String name)` has been
replaced by a `Reader ResourceLoader.getResourceReader(String name, String
encoding)`.
+ the default encoding ('ISO-8859-1' in 1.x) is now UTF-8.
+ the MethodException event handler now receives an additional argument
providing template name and location infos.
