Remove dead code before migrating to single project setup
[aquarium] / logic / src / main / scala / gr / grnet / aquarium / util / package.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
37
38 /**
39  * Utility definitions.
40  *
41  * @author Christos KK Loverdos <loverdos@gmail.com>.
42  */
43 package object util {
44   def tryOption[A](f: => A): Option[A] = {
45     try Some(f)
46     catch {
47       case _: Exception => None
48     }
49   }
50
51   /**
52    * Compute the class name excluding any leading packages.
53    *
54    * This is basically the name after the last dot.
55    */
56   def shortNameOfClass(theClass: Class[_]): String = {
57     val cname = theClass.getName
58     cname.substring(cname.lastIndexOf(".") + 1)
59   }
60
61   /**
62    * For the class of the provided object, compute the class name excluding any leading packages.
63    *
64    * This is basically the name after the last dot.
65    *
66    * The `null` value is mapped to string `"null"`.
67    */
68   def shortClassNameOf(anyRef: AnyRef): String = {
69     anyRef match {
70       case null =>
71         "<null>"
72       case clz: Class[_] =>
73         shortNameOfClass(clz)
74       case obj =>
75         shortNameOfClass(obj.getClass)
76     }
77   }
78
79   def safeToStringOrNull(obj: AnyRef): String = obj match {
80     case null => null
81     case _ => obj.toString
82   }
83
84   def displayableObjectInfo(obj: AnyRef): String = {
85     "[%s] %s".format(obj.getClass, obj)
86   }
87 }