c72e55f72538b6dcb11cdcbe8608792721494cf5
[aquarium] / src / main / scala / gr / grnet / aquarium / util / xstream / ListConverter.scala
1 /*
2  * Copyright 2011-2012 GRNET S.A. All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or
5  * without modification, are permitted provided that the following
6  * conditions are met:
7  *
8  *   1. Redistributions of source code must retain the above
9  *      copyright notice, this list of conditions and the following
10  *      disclaimer.
11  *
12  *   2. Redistributions in binary form must reproduce the above
13  *      copyright notice, this list of conditions and the following
14  *      disclaimer in the documentation and/or other materials
15  *      provided with the distribution.
16  *
17  * THIS SOFTWARE IS PROVIDED BY GRNET S.A. ``AS IS'' AND ANY EXPRESS
18  * OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
19  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
20  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL GRNET S.A OR
21  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
22  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
23  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
24  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
25  * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
26  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
27  * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
28  * POSSIBILITY OF SUCH DAMAGE.
29  *
30  * The views and conclusions contained in the software and
31  * documentation are those of the authors and should not be
32  * interpreted as representing official policies, either expressed
33  * or implied, of GRNET S.A.
34  */
35
36 package gr.grnet.aquarium.util.xstream
37
38 import com.thoughtworks.xstream.XStream
39 import com.thoughtworks.xstream.converters.{MarshallingContext, UnmarshallingContext}
40 import com.thoughtworks.xstream.io.{HierarchicalStreamWriter, HierarchicalStreamReader}
41 import com.thoughtworks.xstream.converters.collections.AbstractCollectionConverter
42 import com.thoughtworks.xstream.mapper.Mapper
43
44 /**
45  * Provides a human-friendlier xstream behavior for Scala lists.
46  *
47  * Taken from `http://stackoverflow.com/questions/1753511/how-can-i-get-xstream-to-output-scala-lists-nicely-can-i-write-a-custom-convert`
48  */
49 class ListConverter(mapper: Mapper) extends AbstractCollectionConverter(mapper) {
50   def canConvert(clazz: Class[_]) = {
51     classOf[::[_]] == clazz
52   }
53
54   def marshal(value: AnyRef, writer: HierarchicalStreamWriter, context: MarshallingContext) = {
55     val list = value.asInstanceOf[List[_]]
56     for(item <- list) {
57       writeItem(item, context, writer)
58     }
59   }
60
61   def unmarshal(reader: HierarchicalStreamReader, context: UnmarshallingContext) = {
62     var list : List[_] = Nil
63     while(reader.hasMoreChildren()) {
64       reader.moveDown();
65       val item = readItem(reader, context, list);
66       list = list ::: List(item)
67       reader.moveUp();
68     }
69     list
70   }
71 }