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 Forward handler will move the date forward if it falls on a non working
43   * day.
44   * 
45   * @author Benoit Xhenseval
46   * 
47   */
48  public class YearMonthDayForwardHandler implements HolidayHandler<YearMonthDay> {
49  
50      /**
51       * If the current date of the give calculator is a non-working day, it will
52       * be moved according to the algorithm implemented.
53       * 
54       * @param calculator
55       *            the calculator
56       * @return the date which may have moved.
57       */
58      public YearMonthDay moveCurrentDate(final DateCalculator<YearMonthDay> calculator) {
59          return move(calculator, 1);
60      }
61  
62      // -----------------------------------------------------------------------
63      //
64      //    ObjectLab, world leaders in the design and development of bespoke 
65      //          applications for the securities financing markets.
66      //                         www.ObjectLab.co.uk
67      //
68      // -----------------------------------------------------------------------
69  
70      protected YearMonthDay move(final DateCalculator<YearMonthDay> calculator, final int step) {
71          YearMonthDay date = calculator.getCurrentBusinessDate();
72          while (calculator.isNonWorkingDay(date)) {
73              date = date.plusDays(step);
74          }
75          return date;
76      }
77  
78      /**
79       * Give the type name for this algorithm.
80       * 
81       * @return algorithm name.
82       */
83      public String getType() {
84          return HolidayHandlerType.FORWARD;
85      }
86  }
87  
88  /*
89   * ObjectLab, http://www.objectlab.co.uk/open is sponsoring the ObjectLab Kit.
90   * 
91   * Based in London, we are world leaders in the design and development 
92   * of bespoke applications for the securities financing markets.
93   * 
94   * <a href="http://www.objectlab.co.uk/open">Click here to learn more about us</a>
95   *           ___  _     _           _   _          _
96   *          / _ \| |__ (_) ___  ___| |_| |    __ _| |__
97   *         | | | | '_ \| |/ _ \/ __| __| |   / _` | '_ \
98   *         | |_| | |_) | |  __/ (__| |_| |__| (_| | |_) |
99   *          \___/|_.__// |\___|\___|\__|_____\__,_|_.__/
100  *                   |__/
101  *
102  *                     www.ObjectLab.co.uk
103  */