8e23a796bda3c58ac8760ba3edb4f741c2a3864d
[aquarium] / src / main / scala / gr / grnet / aquarium / computation / BillingMonthInfo.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.computation
37
38 import gr.grnet.aquarium.util.date.MutableDateCalc
39
40 /**
41  *
42  * @author Christos KK Loverdos <loverdos@gmail.com>
43  */
44
45 final class BillingMonthInfo private(val year: Int,
46                                      val month: Int,
47                                      val startMillis: Long,
48                                      val stopMillis: Long) extends Ordered[BillingMonthInfo] {
49
50   def previousMonth: BillingMonthInfo = {
51     BillingMonthInfo.fromDateCalc(new MutableDateCalc(year, month).goPreviousMonth)
52   }
53
54   def nextMonth: BillingMonthInfo = {
55     BillingMonthInfo.fromDateCalc(new MutableDateCalc(year, month).goNextMonth)
56   }
57
58
59   def compare(that: BillingMonthInfo) = {
60     val ds = this.startMillis - that.startMillis
61     if(ds < 0) -1 else if(ds == 0) 0 else 1
62   }
63
64
65   override def equals(any: Any) = any match {
66     case that: BillingMonthInfo ⇒
67       this.year == that.year && this.month == that.month // normally everything else MUST be the same by construction
68     case _ ⇒
69       false
70   }
71
72   override def hashCode() = {
73     31 * year + month
74   }
75
76   override def toString = "%s-%02d".format(year, month)
77 }
78
79 object BillingMonthInfo {
80   def fromMillis(millis: Long): BillingMonthInfo = {
81     fromDateCalc(new MutableDateCalc(millis))
82   }
83
84   def fromDateCalc(mdc: MutableDateCalc): BillingMonthInfo = {
85     val year = mdc.getYear
86     val month = mdc.getMonthOfYear
87     val startMillis = mdc.goStartOfThisMonth.getMillis
88     val stopMillis = mdc.goEndOfThisMonth.getMillis // no need to `copy` here, since we are discarding `mdc`
89
90     new BillingMonthInfo(year, month, startMillis, stopMillis)
91   }
92 }