Author: gk Date: Fri Mar 14 11:27:52 2014 New Revision: 1577485 URL: http://svn.apache.org/r1577485 Log: add changes and fix documentation
Added: turbine/fulcrum/trunk/json/src/changes/ turbine/fulcrum/trunk/json/src/changes/changes.xml (with props) Modified: turbine/fulcrum/trunk/json/xdocs/index.xml Added: turbine/fulcrum/trunk/json/src/changes/changes.xml URL: http://svn.apache.org/viewvc/turbine/fulcrum/trunk/json/src/changes/changes.xml?rev=1577485&view=auto ============================================================================== --- turbine/fulcrum/trunk/json/src/changes/changes.xml (added) +++ turbine/fulcrum/trunk/json/src/changes/changes.xml Fri Mar 14 11:27:52 2014 @@ -0,0 +1,49 @@ +<?xml version="1.0"?> +<!-- + Licensed to the Apache Software Foundation (ASF) under one + or more contributor license agreements. See the NOTICE file + distributed with this work for additional information + regarding copyright ownership. The ASF licenses this file + to you under the Apache License, Version 2.0 (the + "License"); you may not use this file except in compliance + with the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, + software distributed under the License is distributed on an + "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + KIND, either express or implied. See the License for the + specific language governing permissions and limitations + under the License. +--> +<document> + <properties> + <title>Changes</title> + <author email="g...@apache.org">Georg Kallidis</author> + </properties> + <body> + <release version="1.0.0" date=""> + <action dev="gk" type="add"> + Renamed refreshFilter to cleanFilter/Cache parameter name and added type to more methods in JsonService. + </action> + <action dev="gk" type="update"> + Null-Checking in methods. + Deregistering of adapaters (Tests) + </action> + <action dev="gk" type="add"> + Added mixin deserializing for collection. + </action> + <action dev="gk" type="update"> + Changed from primitive type boolean to Boolean in serialize* methods to avoid errors (ambigous varargs argument handling). + </action> + <action dev="gk" type="add"> + Added refreshFilter parameter to serialize* methods + Added collectionType deserialization + Added method to service interface JsonService to allow for object adapters + More configurable Jackson 2 and GSON service components + </action> + </release> + </body> +</document> + Propchange: turbine/fulcrum/trunk/json/src/changes/changes.xml ------------------------------------------------------------------------------ svn:eol-style = native Modified: turbine/fulcrum/trunk/json/xdocs/index.xml URL: http://svn.apache.org/viewvc/turbine/fulcrum/trunk/json/xdocs/index.xml?rev=1577485&r1=1577484&r2=1577485&view=diff ============================================================================== --- turbine/fulcrum/trunk/json/xdocs/index.xml (original) +++ turbine/fulcrum/trunk/json/xdocs/index.xml Fri Mar 14 11:27:52 2014 @@ -28,25 +28,24 @@ <body> <section name="Overview"> - <p> - This component provides JSON serialization of objects and deserialization of JSON strings. It is written - for use in Turbine but it can be used in any container compatible - with Avalon's ECM container. - There are three implementations + <p>The intent of this component is to provide a configurable and customized integration of JSON De-/Seriallizers ousing GSON, Jackson 1 and Jackson 2 APIs into Avalon/Turbine. + + It is written for use in Turbine but it can be used in any container compatible + with Avalon's ECM container. There are three implementations <ul> <li>GSONBuilderService and</li> <li>Jackson2MapperService</li> <li>JacksonMapperService</li> - </ul>. - All Services <code>SimpleLocalizationService</code> provide basic serialization and deserialization functions - for generic applications. + </ul> + All Services provide basic serialization and deserialization functions for applications. </p> </section> - <section name="JSON Service Component with Jackson API"> + <section name="JSON Service Component with Jackson 1 / 2 API"> <subsection name="Overview"> <p> This Service serves as a JSON serializer or deserializer using <a href="https://github.com/FasterXML/jackson">Jackson</a> Version 2 or Version 1. + The JSON Jackson 2 submodule is the most elaborated of the three sub modules. It provides attribute and class filtering and cache cleaning mechanism. </p> <p> @@ -110,7 +109,7 @@ <td> If set to <code>true</code>, caching is enabled. Each filter applied remains valid and is not removed. This implicits, that you cannot retrieve for the same class/bean different properties in different calls. - You could invalidate (refresh) the cache per class, in many methods, cft. method parameters named <code>refresh*</code> or <code>clean*</code>. The default value is <code>true</code>. + Otherwise different serializations per call are possible. You could invalidate (refresh) the cache per class, in most methods providing a Boolean parameter, cft. method parameters named <code>refresh*</code> or <code>clean*</code>. The default value is <code>true</code>. </td> </tr> </table> @@ -184,9 +183,9 @@ JsonService jsonService = (JsonService)T </p> </subsection> - <subsection name="Integration of JSON to Object Deserialization" id="deser"> + <subsection name="JSON to Object Deserialization" id="deser"> <p> - This could be done by providing the JSON data as client parameter to a JSON-RPC-Service function (cft. services->JSON-RPC-Service). As an example for the function: + This could be done by providing the JSON data as client parameter to a JSON-RPC-Service function (cft. services->JSON-RPC-Service). As an example consider this: </p> <source><![CDATA[ // class is registered in screen @@ -203,7 +202,7 @@ JsonService jsonService = (JsonService)T } } ]]></source> - You could then call the JSON method in Javascript like this: + You could then call the JSON method in a Javascript section like this: <source><![CDATA[ jsonrpc.myFunctions.deSerJsonItem( JSON.stringify(jsonitem) ); ]]></source>