001    /**
002     * Copyright (c) 2000-2012 Liferay, Inc. All rights reserved.
003     *
004     * This library is free software; you can redistribute it and/or modify it under
005     * the terms of the GNU Lesser General Public License as published by the Free
006     * Software Foundation; either version 2.1 of the License, or (at your option)
007     * any later version.
008     *
009     * This library is distributed in the hope that it will be useful, but WITHOUT
010     * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
011     * FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
012     * details.
013     */
014    
015    /*
016     * Copyright (c) 2000, Columbia University.  All rights reserved.
017     *
018     * Redistribution and use in source and binary forms, with or without
019     * modification, are permitted provided that the following conditions are met:
020     *
021     * 1. Redistributions of source code must retain the above copyright
022     *        notice, this list of conditions and the following disclaimer.
023     *
024     * 2. Redistributions in binary form must reproduce the above copyright
025     *        notice, this list of conditions and the following disclaimer in the
026     *        documentation and/or other materials provided with the distribution.
027     *
028     * 3. Neither the name of the University nor the names of its contributors
029     *        may be used to endorse or promote products derived from this software
030     *        without specific prior written permission.
031     *
032     * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS ``AS
033     * IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
034     * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
035     * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR
036     * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
037     * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
038     * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
039     * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
040     * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
041     * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
042     * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
043     */
044    
045    package com.liferay.portal.kernel.cal;
046    
047    import com.liferay.portal.kernel.util.HashCode;
048    import com.liferay.portal.kernel.util.HashCodeFactoryUtil;
049    import com.liferay.portal.kernel.util.StringBundler;
050    
051    import java.io.Serializable;
052    
053    import java.util.Calendar;
054    
055    /**
056     * @author Jonathan Lennox
057     */
058    public class DayAndPosition implements Cloneable, Serializable {
059    
060            /**
061             * Field day
062             */
063            private int day;
064    
065            /**
066             * Field position
067             */
068            private int position;
069    
070            /**
071             * Field NO_WEEKDAY
072             */
073            public static final int NO_WEEKDAY = 0;
074    
075            /**
076             * Constructor DayAndPosition
077             */
078            public DayAndPosition() {
079                    day = NO_WEEKDAY;
080                    position = 0;
081            }
082    
083            /**
084             * Constructor DayAndPosition
085             */
086            public DayAndPosition(int d, int p) {
087                    if (!isValidDayOfWeek(d)) {
088                            throw new IllegalArgumentException("Invalid day of week");
089                    }
090    
091                    if (!isValidDayPosition(p)) {
092                            throw new IllegalArgumentException("Invalid day position");
093                    }
094    
095                    day = d;
096                    position = p;
097            }
098    
099            /**
100             * Method getDayOfWeek
101             *
102             * @return int
103             */
104            public int getDayOfWeek() {
105                    return day;
106            }
107    
108            /**
109             * Method setDayOfWeek
110             */
111            public void setDayOfWeek(int d) {
112                    if (!isValidDayOfWeek(d)) {
113                            throw new IllegalArgumentException("Invalid day of week");
114                    }
115    
116                    day = d;
117            }
118    
119            /**
120             * Method getDayPosition
121             *
122             * @return int
123             */
124            public int getDayPosition() {
125                    return position;
126            }
127    
128            /**
129             * Method setDayPosition
130             */
131            public void setDayPosition(int p) {
132                    if (!isValidDayPosition(p)) {
133                            throw new IllegalArgumentException();
134                    }
135    
136                    position = p;
137            }
138    
139            /**
140             * Method equals
141             *
142             * @return boolean
143             */
144            @Override
145            public boolean equals(Object obj) {
146                    if (obj == null) {
147                            return false;
148                    }
149    
150                    if (this == obj) {
151                            return true;
152                    }
153    
154                    if (!(obj instanceof DayAndPosition)) {
155                            return false;
156                    }
157    
158                    DayAndPosition that = (DayAndPosition)obj;
159    
160                    return (getDayOfWeek() == that.getDayOfWeek())
161                               && (getDayPosition() == that.getDayPosition());
162            }
163    
164            @Override
165            public int hashCode() {
166                    HashCode hashCode = HashCodeFactoryUtil.getHashCode();
167    
168                    hashCode.append(day);
169                    hashCode.append(position);
170    
171                    return hashCode.toHashCode();
172            }
173    
174            /**
175             * Method isValidDayOfWeek
176             *
177             * @return boolean
178             */
179            public static boolean isValidDayOfWeek(int d) {
180                    switch (d) {
181    
182                            case NO_WEEKDAY :
183                            case Calendar.SUNDAY :
184                            case Calendar.MONDAY :
185                            case Calendar.TUESDAY :
186                            case Calendar.WEDNESDAY :
187                            case Calendar.THURSDAY :
188                            case Calendar.FRIDAY :
189                            case Calendar.SATURDAY :
190                                    return true;
191    
192                            default :
193                                    return false;
194                    }
195            }
196    
197            /**
198             * Method isValidDayPosition
199             *
200             * @return boolean
201             */
202            public static boolean isValidDayPosition(int p) {
203                    return ((p >= -53) && (p <= 53));
204            }
205    
206            /**
207             * Method clone
208             *
209             * @return Object
210             */
211            @Override
212            public Object clone() {
213                    try {
214                            DayAndPosition other = (DayAndPosition)super.clone();
215    
216                            other.day = day;
217                            other.position = position;
218    
219                            return other;
220                    }
221                    catch (CloneNotSupportedException e) {
222                            throw new InternalError();
223                    }
224            }
225    
226            /**
227             * Method toString
228             *
229             * @return String
230             */
231            @Override
232            public String toString() {
233                    StringBundler sb = new StringBundler(6);
234    
235                    sb.append(getClass().getName());
236                    sb.append("[day=");
237                    sb.append(day);
238                    sb.append(",position=");
239                    sb.append(position);
240                    sb.append("]");
241    
242                    return sb.toString();
243            }
244    
245    }