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