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, free/busy component, or timezone component
035     * starts.
036     * </p>
037     * <p>
038     * <b>Examples:</b>
039     * 
040     * <pre class="brush:java">
041     * //date and time
042     * Date datetime = ...
043     * DateStart dtstart = new DateStart(datetime);
044     * 
045     * //date (without time component)
046     * Date date = ...
047     * DateStart dtstart = new DateStart(date, false);
048     * 
049     * //local date and time (don't print a timezone)
050     * Date datetime = ...
051     * DateStart dtstart = new DateStart(datetime);
052     * dtstart.setLocalTime(true);
053     * 
054     * //with timezone (will output the Date object in the specified timezone)
055     * Date datetime = ... 
056     * DateStart dtstart = new DateStart(datetime); 
057     * dtstart.setTimezoneId("America/New_York");
058     * 
059     * //raw components 
060     * DateTimeComponents components = new DateTimeComponents(1999, 4, 4, 2, 0, 0, false);
061     * DateStart dtstart = new DateStart(components);
062     * </pre>
063     * 
064     * </p>
065     * @author Michael Angstadt
066     * @rfc 5545 p.97-8
067     */
068    public class DateStart extends DateOrDateTimeProperty {
069            /**
070             * Creates a start date property.
071             * @param startDate the start date
072             */
073            public DateStart(Date startDate) {
074                    this(startDate, true);
075            }
076    
077            /**
078             * Creates a start date property.
079             * @param startDate the start date
080             * @param hasTime true to include the time component of the date, false not
081             * to
082             */
083            public DateStart(Date startDate, boolean hasTime) {
084                    super(startDate, hasTime);
085            }
086    
087            /**
088             * Creates a start date property.
089             * @param components the raw components of the date-time value
090             */
091            public DateStart(DateTimeComponents components) {
092                    super(components);
093            }
094    }