Remove dead code before migrating to single project setup
[aquarium] / logic / src / main / scala / gr / grnet / aquarium / util / DateUtils.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
38 import scala.collection.mutable
39 import java.util.{Calendar, Date, GregorianCalendar}
40 import gr.grnet.aquarium.logic.accounting.dsl.Timeslot
41
42 /**
43  * Various utils for manipulating dates, with special
44  * emphasis on credit DSL requirements.
45  *
46  * @author Georgios Gousios <gousiosg@gmail.com>
47  */
48 trait DateUtils {
49
50   /**
51    * Returns a date that is either equal to the latest of
52    * (`d - 1 year`, `limit`)
53    */
54   def oneYearBack(d: Date, limit: Date): Date = {
55     val c = new GregorianCalendar()
56     c.setTime(d)
57     c.add(Calendar.YEAR, -1)
58     if (c.getTime.before(limit))
59       limit
60     else
61       c.getTime
62   }
63
64   /**
65    * Returns a date that is either equal to the earliest of
66    * (`d + 1 year`, `limit`)
67    */
68   def oneYearAhead(d: Date, limit: Date): Date = {
69     val c = new GregorianCalendar()
70     c.setTime(d)
71     c.add(Calendar.YEAR, 1)
72     if (c.getTime.before(limit))
73       c.getTime
74     else
75       limit
76   }
77
78   /**
79    * Search within
80    */
81   def findDays(from: Date, to: Date, f: Calendar => Boolean) : List[Date] = {
82     val c = new GregorianCalendar()
83     val result = new mutable.ListBuffer[Date]()
84
85     c.setTime(from)
86
87     while (c.getTime().getTime <= to.getTime) {
88       if (f(c))
89         result += new Date(c.getTime.getTime)
90       c.add(Calendar.DAY_OF_YEAR, 1)
91     }
92
93     result.toList
94   }
95
96   /**
97    * Adjust time in the provided date to the provided values
98    */
99   def adjustToTime(d: Date, h: Int,  m: Int): Date = {
100
101     assert((0 <= h) && (h <= 23))
102     assert((0 <= m) && (m <= 59))
103
104     val c = new GregorianCalendar()
105     c.setTime(d)
106     c.roll(Calendar.MINUTE, m - c.get(Calendar.MINUTE))
107     c.roll(Calendar.HOUR_OF_DAY, h - c.get(Calendar.HOUR_OF_DAY))
108     c.getTime
109   }
110 }