View Javadoc
1   /*
2    * ObjectLab, http://www.objectlab.co.uk/open is sponsoring the ObjectLab Kit.
3    *
4    * Based in London, we are world leaders in the design and development
5    * of bespoke applications for the securities financing markets.
6    *
7    * <a href="http://www.objectlab.co.uk/open">Click here to learn more</a>
8    *           ___  _     _           _   _          _
9    *          / _ \| |__ (_) ___  ___| |_| |    __ _| |__
10   *         | | | | '_ \| |/ _ \/ __| __| |   / _` | '_ \
11   *         | |_| | |_) | |  __/ (__| |_| |__| (_| | |_) |
12   *          \___/|_.__// |\___|\___|\__|_____\__,_|_.__/
13   *                   |__/
14   *
15   *                     www.ObjectLab.co.uk
16   *
17   * $Id$
18   *
19   * Copyright 2006 the original author or authors.
20   *
21   * Licensed under the Apache License, Version 2.0 (the "License"); you may not
22   * use this file except in compliance with the License. You may obtain a copy of
23   * the License at
24   *
25   * http://www.apache.org/licenses/LICENSE-2.0
26   *
27   * Unless required by applicable law or agreed to in writing, software
28   * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
29   * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
30   * License for the specific language governing permissions and limitations under
31   * the License.
32   */
33  package net.objectlab.kit.datecalc.jdk;
34  
35  import java.util.Calendar;
36  
37  import net.objectlab.kit.datecalc.common.BaseCalculator;
38  import net.objectlab.kit.datecalc.common.HolidayHandler;
39  import net.objectlab.kit.datecalc.common.HolidayHandlerType;
40  import net.objectlab.kit.datecalc.common.NonWorkingDayChecker;
41  
42  /**
43   * A Jdk <code>Calendar</code> implementation of the
44   * {@link net.objectlab.kit.datecalc.common.HolidayHandler}, for the
45   * <strong>Forward</strong> algorithm.
46   *
47   * @author Marcin Jekot
48   */
49  public class CalendarForwardHandler implements HolidayHandler<Calendar> {
50  
51      /**
52       * If the current date of the give calculator is a non-working day, it will
53       * be moved according to the algorithm implemented.
54       *
55       * @param calculator
56       *            the calculator
57       * @return the date which may have moved.
58       */
59      public Calendar moveCurrentDate(final BaseCalculator<Calendar> calculator) {
60          return adjustDate(calculator.getCurrentBusinessDate(), 1, calculator);
61      }
62  
63      // -----------------------------------------------------------------------
64      //
65      // ObjectLab, world leaders in the design and development of bespoke
66      // applications for the securities financing markets.
67      // www.ObjectLab.co.uk
68      //
69      // -----------------------------------------------------------------------
70      public Calendar adjustDate(final Calendar startDate, final int increment, final NonWorkingDayChecker<Calendar> checker) {
71          final Calendar cal = (Calendar) startDate.clone();
72  
73          while (checker.isNonWorkingDay(cal)) {
74              cal.add(Calendar.DAY_OF_MONTH, increment);
75          }
76  
77          return cal;
78      }
79  
80      /**
81       * Give the type name for this algorithm.
82       *
83       * @return algorithm name.
84       */
85      public String getType() {
86          return HolidayHandlerType.FORWARD;
87      }
88  }
89  
90  /*
91   * ObjectLab, http://www.objectlab.co.uk/open is sponsoring the ObjectLab Kit.
92   *
93   * Based in London, we are world leaders in the design and development
94   * of bespoke applications for the securities financing markets.
95   *
96   * <a href="http://www.objectlab.co.uk/open">Click here to learn more about us</a>
97   *           ___  _     _           _   _          _
98   *          / _ \| |__ (_) ___  ___| |_| |    __ _| |__
99   *         | | | | '_ \| |/ _ \/ __| __| |   / _` | '_ \
100  *         | |_| | |_) | |  __/ (__| |_| |__| (_| | |_) |
101  *          \___/|_.__// |\___|\___|\__|_____\__,_|_.__/
102  *                   |__/
103  *
104  *                     www.ObjectLab.co.uk
105  */