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.DateRange;
55 import org.chronicj.Event;
56 import org.chronicj.ScheduleElement;
57 import org.chronicj.TemporalExpression;
58 import org.chronicj.TimePoint;
59
60
61 /***
62 * Default implementation of a {@link org.chronicj.ScheduleElement
63 * ScheduleElement} that can be used to compose a {@link
64 * org.chronicj.Schedule Schedule}.
65 *
66 * @author <a href="mlipper@US-ABP.com">Matthew Lipper</a>
67 *
68 * @see org.chronicj.ScheduleElement
69 */
70 public class DefaultScheduleElement implements ScheduleElement {
71 private Event event;
72 private TemporalExpression expression;
73
74 /***
75 * Create a default {@link org.chronicj.ScheduleElement ScheduleElement}
76 * using the supplied {@link org.chronicj.Event Event} and {@link
77 * org.chronicj.TemporalExpression TemporalExpression}.
78 *
79 * @throws NullPointerException if either argument is null
80 *
81 * @param anEvent the event to be scheduled
82 * @param anExpression the TemporalExpression that defines when the event occurs
83 */
84 public DefaultScheduleElement(Event anEvent, TemporalExpression anExpression) {
85 super();
86
87 if (null == anEvent) {
88 throw new NullPointerException("Event argument cannot be null.");
89 }
90
91 event = anEvent;
92
93 if (null == anExpression) {
94 throw new NullPointerException(
95 "TemporalExpression argument cannot be null.");
96 }
97
98 expression = anExpression;
99 }
100
101 /***
102 * Default implementation of {@link org.chronicj.ScheduleElement#isOccuring(org.chronicj.Event,org.chronicj.TimePoint)}
103 * that will return true if the supplied {@link org.chronicj.Event Event}
104 * takes place during the supplied {@link org.chronicj.TimePoint TimePoint}.
105 *
106 * @param anEvent the Event whose schedule is being queried
107 * @param aTimePoint an instant in time
108 *
109 * @return a boolean value indicating whether the event is occuring at the
110 * specified TimePoint
111 *
112 * @throws NullPointerException if either argument is null
113 *
114 * @see org.chronicj.ScheduleElement#isOccuring(org.chronicj.Event,org.chronicj.TimePoint)
115 */
116 public boolean isOccuring(Event anEvent, TimePoint aTimePoint) {
117 if (null == anEvent) {
118 throw new NullPointerException("Event argument cannot be null.");
119 }
120
121 if (null == aTimePoint) {
122 throw new NullPointerException("TimePoint argument cannot be null.");
123 }
124
125 if (event.equals(anEvent)) {
126 return expression.includes(aTimePoint);
127 }
128
129 return false;
130 }
131
132 /***
133 * Default implementation of {@link org.chronicj.ScheduleElement#isOccuring(org.chronicj.Event,org.chronicj.DateRangeImpl)}
134 * that will return the logical AND of calling
135 * {@link DefaultScheduleElement#isOccuring(org.chronicj.Event,org.chronicj.TimePoint)}
136 * for the start and end dates of the supplied DateRange.
137 *
138 * @param anEvent the Event whose schedule is being queried
139 * @param aDateRange the time period in which to check
140 *
141 * @return a boolean value indicating whether the event occurs within the
142 * specified DateRange
143 *
144 * @throws NullPointerException if either argument is null
145 * @throws IllegalArgumentException if the DateRange argument is empty
146 *
147 * @see org.chronicj.ScheduleElement#isOccuring(org.chronicj.Event,
148 * org.chronicj.DateRangeImpl)
149 */
150 public boolean isOccuring(Event anEvent, DateRange aDateRange) {
151 if (null == anEvent) {
152 throw new NullPointerException("Event argument cannot be null.");
153 }
154
155 if (null == aDateRange) {
156 throw new NullPointerException("DateRange argument cannot be null.");
157 }
158
159 if (aDateRange.isEmpty()) {
160 throw new IllegalArgumentException(
161 "DateRange argument cannot be empty.");
162 }
163
164 if (event.equals(anEvent)) {
165 return expression.includes(aDateRange.start()) &&
166 expression.includes(aDateRange.end());
167 }
168
169 return false;
170 }
171 }
This page was automatically generated by Maven