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.joda;
34  
35  import net.objectlab.kit.datecalc.common.BaseCalculator;
36  import net.objectlab.kit.datecalc.common.HolidayHandler;
37  import net.objectlab.kit.datecalc.common.HolidayHandlerType;
38  import net.objectlab.kit.datecalc.common.NonWorkingDayChecker;
39  
40  import org.joda.time.LocalDate;
41  
42  /**
43   * A modified following handler will move the date forward if it falls on a non
44   * working day BUT, if the new date falls into another month, it will revert to
45   * moving backward until it finds a working day.
46   *
47   * @author Benoit Xhenseval
48   *
49   */
50  public class LocalDateModifiedFollowingHandler implements HolidayHandler<LocalDate> {
51  
52      /**
53       * If the current date of the give calculator is a non-working day, it will
54       * be moved according to the algorithm implemented.
55       *
56       * @param calculator
57       *            the calculator
58       * @return the date which may have moved.
59       */
60      public LocalDate moveCurrentDate(final BaseCalculator<LocalDate> calculator) {
61          return adjustDate(calculator.getCurrentBusinessDate(), 1, calculator);
62      }
63  
64      // -----------------------------------------------------------------------
65      //
66      // ObjectLab, world leaders in the design and development of bespoke
67      // applications for the securities financing markets.
68      // www.ObjectLab.co.uk
69      //
70      // -----------------------------------------------------------------------
71  
72      public LocalDate adjustDate(LocalDate startDate, int increment, NonWorkingDayChecker<LocalDate> checker) {
73          LocalDate date = startDate;
74          final int month = date.getMonthOfYear();
75          int stepToUse = increment;
76          while (checker.isNonWorkingDay(date)) {
77              date = date.plusDays(stepToUse);
78              if (date.getMonthOfYear() != month) {
79                  // flick to backward
80                  stepToUse *= -1;
81                  date = date.plusDays(stepToUse);
82              }
83          }
84          return date;
85      }
86  
87      /**
88       * Give the type name for this algorithm.
89       *
90       * @return algorithm name.
91       */
92      public String getType() {
93          return HolidayHandlerType.MODIFIED_FOLLOWING;
94      }
95  }
96  
97  /*
98   * ObjectLab, http://www.objectlab.co.uk/open is sponsoring the ObjectLab Kit.
99   *
100  * Based in London, we are world leaders in the design and development
101  * of bespoke applications for the securities financing markets.
102  *
103  * <a href="http://www.objectlab.co.uk/open">Click here to learn more about us</a>
104  *           ___  _     _           _   _          _
105  *          / _ \| |__ (_) ___  ___| |_| |    __ _| |__
106  *         | | | | '_ \| |/ _ \/ __| __| |   / _` | '_ \
107  *         | |_| | |_) | |  __/ (__| |_| |__| (_| | |_) |
108  *          \___/|_.__// |\___|\___|\__|_____\__,_|_.__/
109  *                   |__/
110  *
111  *                     www.ObjectLab.co.uk
112  */