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  import java.util.Date;
37  
38  import net.objectlab.kit.datecalc.common.BaseCalculator;
39  import net.objectlab.kit.datecalc.common.HolidayHandler;
40  import net.objectlab.kit.datecalc.common.HolidayHandlerType;
41  import net.objectlab.kit.datecalc.common.NonWorkingDayChecker;
42  import net.objectlab.kit.datecalc.common.Utils;
43  
44  /**
45   * A Jdk <code>Date</code> implementation of the
46   * {@link net.objectlab.kit.datecalc.common.HolidayHandler}, for the
47   * <strong>Forward</strong> algorithm.
48   *
49   * @author Marcin Jekot
50   *
51   */
52  public class DateForwardHandler implements HolidayHandler<Date> {
53  
54      /**
55       * If the current date of the give calculator is a non-working day, it will
56       * be moved according to the algorithm implemented.
57       *
58       * @param calculator
59       *            the calculator
60       * @return the date which may have moved.
61       */
62      public Date moveCurrentDate(final BaseCalculator<Date> calculator) {
63          return adjustDate(calculator.getCurrentBusinessDate(), 1, calculator);
64      }
65  
66      // -----------------------------------------------------------------------
67      //
68      // ObjectLab, world leaders in the design and development of bespoke
69      // applications for the securities financing markets.
70      // www.ObjectLab.co.uk
71      //
72      // -----------------------------------------------------------------------
73  
74      public Date adjustDate(final Date startDate, final int step, final NonWorkingDayChecker<Date> checker) {
75          final Calendar cal = Utils.getCal(startDate);
76  
77          while (checker.isNonWorkingDay(cal.getTime())) {
78              cal.add(Calendar.DAY_OF_MONTH, step);
79          }
80  
81          return cal.getTime();
82      }
83  
84      /**
85       * Give the type name for this algorithm.
86       *
87       * @return algorithm name.
88       */
89      public String getType() {
90          return HolidayHandlerType.FORWARD;
91      }
92  }
93  
94  /*
95   * ObjectLab, http://www.objectlab.co.uk/open is sponsoring the ObjectLab Kit.
96   *
97   * Based in London, we are world leaders in the design and development
98   * of bespoke applications for the securities financing markets.
99   *
100  * <a href="http://www.objectlab.co.uk/open">Click here to learn more about us</a>
101  *           ___  _     _           _   _          _
102  *          / _ \| |__ (_) ___  ___| |_| |    __ _| |__
103  *         | | | | '_ \| |/ _ \/ __| __| |   / _` | '_ \
104  *         | |_| | |_) | |  __/ (__| |_| |__| (_| | |_) |
105  *          \___/|_.__// |\___|\___|\__|_____\__,_|_.__/
106  *                   |__/
107  *
108  *                     www.ObjectLab.co.uk
109  */