1 /* ====================================================================
2 * The Apache Software License, Version 1.1
3 *
4 * Copyright (c) 2003 Digital Clash LLC. All rights
5 * reserved.
6 *
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
9 * are met:
10 *
11 * 1. Redistributions of source code must retain the above copyright
12 * notice, this list of conditions and the following disclaimer.
13 *
14 * 2. Redistributions in binary form must reproduce the above copyright
15 * notice, this list of conditions and the following disclaimer in
16 * the documentation and/or other materials provided with the
17 * distribution.
18 *
19 * 3. The end-user documentation included with the redistribution,
20 * if any, must include the following acknowledgment:
21 * "This product includes software developed by the
22 * ChronicJ team (http://www.chronicj.org/)."
23 * Alternately, this acknowledgment may appear in the software itself,
24 * if and wherever such third-party acknowledgments normally appear.
25 *
26 * 4. The names "ChronicJ" and "Digital Clash" not be used to endorse or
27 * promote products derived from this software without prior written
28 * permission. For written permission, please contact
29 * info@digitalclash.com.
30 *
31 * 5. Products derived from this software may not be called "ChronicJ",
32 * "Digital Clash", nor may "ChronicJ" or "Digital Clash" appear in
33 * their name, without prior written permission of Digital Clash LLC.
34 *
35 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
36 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
37 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
38 * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
39 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
40 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
41 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
42 * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
43 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
44 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
45 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
46 * SUCH DAMAGE.
47 * ====================================================================
48 * This product includes software developed by the by the
49 * Apache Software Foundation (http://www.apache.org/).
50 * ====================================================================
51 */
52 package org.chronicj.impl;
53
54 import org.chronicj.TemporalExpression;
55 import org.chronicj.TimePoint;
56
57
58 /***
59 * <p>
60 * {@link org.chronicj.TemporalExpression} that provides the difference of
61 * two composing expressions; for use in a set expression.
62 * </p>
63 *
64 * <p>
65 * This class is based directly on patterns described in a paper by Martin
66 * Fowler which can be found <a
67 * href="http://martinfowler.com/apsupp/recurring.pdf">here</a>.
68 * </p>
69 *
70 * @author <a href="mlipper@US-ABP.com">Matthew Lipper</a>
71 *
72 * @see <a href="http://martinfowler.com/apsupp/recurring.pdf">Recurring Events
73 * for Calendars</a> by Martin Fowler
74 */
75 public class DifferenceTE extends AbstractTemporalExpression {
76 private final TemporalExpression excluded;
77 private final TemporalExpression included;
78
79 /***
80 * Creates an instance of DifferenceTE using two other
81 * <code>TemporalExpression</code>s such that the new expression matches
82 * dates/times based on the set defined by argument 1 - argument 2.
83 *
84 * @param included the full TemporalExpression
85 * @param excluded the TemporalExpression that is "subtracted" from the
86 * full set
87 *
88 * @throws NullPointerException if either argument is null
89 */
90 public DifferenceTE(TemporalExpression included, TemporalExpression excluded) {
91 super();
92
93 if (included == null) {
94 throw new NullPointerException(
95 "TemporalExpression (argument 0) cannot be null.");
96 }
97
98 if (excluded == null) {
99 throw new NullPointerException(
100 "TemporalExpression (argument 1) cannot be null.");
101 }
102
103 this.included = included;
104 this.excluded = excluded;
105 }
106
107 /*
108 * @see org.chronicj.TemporalExpression#includes(org.chronicj.TimePoint)
109 */
110 public boolean includes(TimePoint aTimePoint) {
111 return included.includes(aTimePoint) && !excluded.includes(aTimePoint);
112 }
113 }
This page was automatically generated by Maven