e463c448858cafc9c1a975362bab28b9344d7184
[aquarium] / src / main / scala / gr / grnet / aquarium / util / LazyLoggable.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
37
38 import org.slf4j.LoggerFactory
39
40 /**
41  * Like [[gr.grnet.aquarium.util.Loggable]] but the underlying logger is lazily evaluated.
42  *
43  * @author Christos KK Loverdos <loverdos@gmail.com>
44  */
45
46 trait LazyLoggable {
47   @transient
48   protected lazy val logger = LoggerFactory.getLogger(getClass)
49
50   protected def logStarting(): Unit = {
51     LogHelpers.logStarting(this.logger)
52   }
53
54   protected def logStarting(fmt: String, args: Any*): Unit = {
55     LogHelpers.logStarting(this.logger, fmt, args: _*)
56   }
57
58   protected def logStarted(ms0: Long, ms1: Long): Unit = {
59     LogHelpers.logStarted(this.logger, ms0, ms1)
60   }
61
62   protected def logStarted(ms0: Long, ms1: Long, fmt: String, args: Any*): Unit = {
63     LogHelpers.logStarted(this.logger, ms0, ms1, fmt, args: _*)
64   }
65
66   protected def logStopping(): Unit = {
67     LogHelpers.logStopping(this.logger)
68   }
69
70   protected def logStopped(ms0: Long, ms1: Long): Unit = {
71     LogHelpers.logStopped(this.logger, ms0, ms1)
72   }
73
74   protected def logStopped(ms0: Long, ms1: Long, fmt: String, args: Any*): Unit = {
75     LogHelpers.logStopped(this.logger, ms0, ms1, fmt, args: _*)
76   }
77 }