code.grnet.gr Git - aquarium/blob - logic/src/main/scala/gr/grnet/aquarium/util/xstream/XStreamHelpers.scala

   1 /*
   2  * Copyright 2011 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
  37 package xstream
  38
  39 import com.thoughtworks.xstream.XStream
  40 import com.ckkloverdos.maybe.{Failed, Just, Maybe}
  41 import com.ckkloverdos.resource.StreamResource
  42
  43 /**
  44  * Utilities for making our life easier with the XStream library.
  45  *
  46  * If you need to grab an `XStream`, use `newXStream` or the `DefaultXStream`.
  47  *
  48  * @author Christos KK Loverdos <loverdos@gmail.com>.
  49  */
  50 object XStreamHelpers {
  51   val DefaultXStream = newXStream
  52
  53   def prepareXStreamAlias[T : Manifest](xs: XStream): XStream = {
  54     val theClass = manifest[T].erasure
  55     xs.alias(shortNameOfClass(theClass), theClass)
  56     xs
  57   }
  58
  59   def prepareXStreamAliases(xs: XStream): XStream = {
  60     xs.alias("List", classOf[::[_]])
  61     xs.alias("Nil", manifest[Nil.type].erasure)
  62     xs
  63   }
  64
  65   def prepareXStreamConverters(xs: XStream): XStream = {
  66     xs.registerConverter(new ListConverter(xs.getMapper))
  67     xs
  68   }
  69
  70   def prepareXStream(xs: XStream): XStream = {
  71     prepareXStreamAliases(xs)
  72     prepareXStreamConverters(xs)
  73   }
  74
  75   def newXStream: XStream = prepareXStream(new XStream)
  76
  77   def parseType[T: Manifest](xml: String, xs: XStream = DefaultXStream): Maybe[T] = {
  78     try Just(xs.fromXML(xml).asInstanceOf[T])
  79     catch {
  80       case e: Exception => Failed(e, "XStream could not parse XML to value of type %s".format(manifest[T]))
  81     }
  82   }
  83
  84   def parseType[T : Manifest](resource: StreamResource, xs: XStream): Maybe[T] = {
  85     resource.mapString(parseType[T](_, xs)).flatten1
  86   }
  87 }