001    package biweekly.property;
002    
003    import java.util.Date;
004    
005    import biweekly.util.DateTimeComponents;
006    
007    /*
008     Copyright (c) 2013, Michael Angstadt
009     All rights reserved.
010    
011     Redistribution and use in source and binary forms, with or without
012     modification, are permitted provided that the following conditions are met: 
013    
014     1. Redistributions of source code must retain the above copyright notice, this
015     list of conditions and the following disclaimer. 
016     2. Redistributions in binary form must reproduce the above copyright notice,
017     this list of conditions and the following disclaimer in the documentation
018     and/or other materials provided with the distribution. 
019    
020     THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
021     ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
022     WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
023     DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
024     ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
025     (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
026     LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
027     ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
028     (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
029     SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
030     */
031    
032    /**
033     * <p>
034     * Defines the date that an event or free/busy component ends.
035     * </p>
036     * <p>
037     * <b>Examples:</b>
038     * 
039     * <pre class="brush:java">
040     * //date and time
041     * Date datetime = ...
042     * DateEnd dtend = new DateEnd(datetime);
043     * 
044     * //date (without time component)
045     * Date date = ...
046     * DateEnd dtend = new DateEnd(date, false);
047     * 
048     * //with timezone (will output the Date object in the specified timezone)
049     * Date datetime = ... 
050     * DateEnd dtend = new DateEnd(datetime); 
051     * dtend.setTimezoneId("America/New_York");
052     * 
053     * //raw components 
054     * DateTimeComponents components = new DateTimeComponents(1999, 4, 4, 2, 0, 0, false);
055     * DateEnd dtend = new DateEnd(components);
056     * </pre>
057     * 
058     * </p>
059     * @author Michael Angstadt
060     * @rfc 5545 p.95-6
061     */
062    public class DateEnd extends DateOrDateTimeProperty {
063            /**
064             * Creates an end date property.
065             * @param endDate the end date
066             */
067            public DateEnd(Date endDate) {
068                    this(endDate, true);
069            }
070    
071            /**
072             * Creates an end date property.
073             * @param endDate the end date
074             * @param hasTime true to include the time component of the date, false not
075             * to
076             */
077            public DateEnd(Date endDate, boolean hasTime) {
078                    super(endDate, hasTime);
079            }
080    
081            /**
082             * Creates an end date property.
083             * @param components the raw components of the date-time value
084             */
085            public DateEnd(DateTimeComponents components) {
086                    super(components);
087            }
088    }