michael@0: /**
michael@0:  * Copyright (c) 2012, Ben Fortuna
michael@0:  * All rights reserved.
michael@0:  *
michael@0:  * Redistribution and use in source and binary forms, with or without
michael@0:  * modification, are permitted provided that the following conditions
michael@0:  * are met:
michael@0:  *
michael@0:  *  o Redistributions of source code must retain the above copyright
michael@0:  * notice, this list of conditions and the following disclaimer.
michael@0:  *
michael@0:  *  o Redistributions in binary form must reproduce the above copyright
michael@0:  * notice, this list of conditions and the following disclaimer in the
michael@0:  * documentation and/or other materials provided with the distribution.
michael@0:  *
michael@0:  *  o Neither the name of Ben Fortuna nor the names of any other contributors
michael@0:  * may be used to endorse or promote products derived from this software
michael@0:  * without specific prior written permission.
michael@0:  *
michael@0:  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
michael@0:  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
michael@0:  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
michael@0:  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
michael@0:  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
michael@0:  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
michael@0:  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
michael@0:  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
michael@0:  * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
michael@0:  * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
michael@0:  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
michael@0:  */
michael@0: package net.fortuna.ical4j.model.property;
michael@0: 
michael@0: import java.text.ParseException;
michael@0: 
michael@0: import net.fortuna.ical4j.model.Date;
michael@0: import net.fortuna.ical4j.model.ParameterList;
michael@0: import net.fortuna.ical4j.model.PropertyFactoryImpl;
michael@0: import net.fortuna.ical4j.model.TimeZone;
michael@0: import net.fortuna.ical4j.model.ValidationException;
michael@0: 
michael@0: /**
michael@0:  * $Id$
michael@0:  * 
michael@0:  * Created: [Apr 6, 2004]
michael@0:  *
michael@0:  * Defines a DTEND iCalendar component property.
michael@0:  * 
michael@0:  * <pre>
michael@0:  *     4.8.2.2 Date/Time End
michael@0:  *     
michael@0:  *        Property Name: DTEND
michael@0:  *     
michael@0:  *        Purpose: This property specifies the date and time that a calendar
michael@0:  *        component ends.
michael@0:  *     
michael@0:  *        Value Type: The default value type is DATE-TIME. The value type can
michael@0:  *        be set to a DATE value type.
michael@0:  *     
michael@0:  *        Property Parameters: Non-standard, value data type, time zone
michael@0:  *        identifier property parameters can be specified on this property.
michael@0:  *     
michael@0:  *        Conformance: This property can be specified in &quot;VEVENT&quot; or
michael@0:  *        &quot;VFREEBUSY&quot; calendar components.
michael@0:  *     
michael@0:  *        Description: Within the &quot;VEVENT&quot; calendar component, this property
michael@0:  *        defines the date and time by which the event ends. The value MUST be
michael@0:  *        later in time than the value of the &quot;DTSTART&quot; property.
michael@0:  *     
michael@0:  *        Within the &quot;VFREEBUSY&quot; calendar component, this property defines the
michael@0:  *        end date and time for the free or busy time information. The time
michael@0:  *        MUST be specified in the UTC time format. The value MUST be later in
michael@0:  *        time than the value of the &quot;DTSTART&quot; property.
michael@0:  *     
michael@0:  *        Format Definition: The property is defined by the following notation:
michael@0:  *     
michael@0:  *          dtend      = &quot;DTEND&quot; dtendparam&quot;:&quot; dtendval CRLF
michael@0:  *     
michael@0:  *          dtendparam = *(
michael@0:  *     
michael@0:  *                     ; the following are optional,
michael@0:  *                     ; but MUST NOT occur more than once
michael@0:  *     
michael@0:  *                     (&quot;;&quot; &quot;VALUE&quot; &quot;=&quot; (&quot;DATE-TIME&quot; / &quot;DATE&quot;)) /
michael@0:  *                     (&quot;;&quot; tzidparam) /
michael@0:  *     
michael@0:  *                     ; the following is optional,
michael@0:  *                     ; and MAY occur more than once
michael@0:  *     
michael@0:  *                     (&quot;;&quot; xparam)
michael@0:  *     
michael@0:  *                     )
michael@0:  *     
michael@0:  *     
michael@0:  *     
michael@0:  *          dtendval   = date-time / date
michael@0:  *          ;Value MUST match value type
michael@0:  * </pre>
michael@0:  * 
michael@0:  * Examples:
michael@0:  * 
michael@0:  * <pre>
michael@0:  *      // construct an end date from a start date and a duration..
michael@0:  *      DtStart start = ...
michael@0:  *      Dur oneWeek = new Dur(&quot;1W&quot;);
michael@0:  *      DtEnd end = new DtEnd(oneWeek.getTime(start.getDate());
michael@0:  * </pre>
michael@0:  * 
michael@0:  * @author Ben Fortuna
michael@0:  */
michael@0: public class DtEnd extends DateProperty {
michael@0: 
michael@0:     private static final long serialVersionUID = 8107416684717228297L;
michael@0: 
michael@0:     /**
michael@0:      * Default constructor. The time value is initialised to the time of instantiation.
michael@0:      */
michael@0:     public DtEnd() {
michael@0:         super(DTEND, PropertyFactoryImpl.getInstance());
michael@0:     }
michael@0: 
michael@0:     /**
michael@0:      * Creates a new DTEND property initialised with the specified timezone.
michael@0:      * @param timezone initial timezone
michael@0:      */
michael@0:     public DtEnd(TimeZone timezone) {
michael@0:         super(DTEND, timezone, PropertyFactoryImpl.getInstance());
michael@0:     }
michael@0: 
michael@0:     /**
michael@0:      * Creates a new instance initialised with the parsed value.
michael@0:      * @param value the DTEND value string to parse
michael@0:      * @throws ParseException where the specified string is not a valid DTEND value representation
michael@0:      */
michael@0:     public DtEnd(final String value) throws ParseException {
michael@0:         super(DTEND, PropertyFactoryImpl.getInstance());
michael@0:         setValue(value);
michael@0:     }
michael@0: 
michael@0:     /**
michael@0:      * Creates a new DTEND property initialised with the specified timezone and value.
michael@0:      * @param value a string representation of a DTEND value
michael@0:      * @param timezone initial timezone
michael@0:      * @throws ParseException where the specified value is not a valid string
michael@0:      * representation
michael@0:      */
michael@0:     public DtEnd(String value, TimeZone timezone) throws ParseException {
michael@0:         super(DTEND, timezone, PropertyFactoryImpl.getInstance());
michael@0:         setValue(value);
michael@0:     }
michael@0: 
michael@0:     /**
michael@0:      * @param aList a list of parameters for this component
michael@0:      * @param aValue a value string for this component
michael@0:      * @throws ParseException when the specified string is not a valid date/date-time representation
michael@0:      */
michael@0:     public DtEnd(final ParameterList aList, final String aValue)
michael@0:             throws ParseException {
michael@0:         super(DTEND, aList, PropertyFactoryImpl.getInstance());
michael@0:         setValue(aValue);
michael@0:     }
michael@0: 
michael@0:     /**
michael@0:      * Constructor. Date or Date-Time format is determined based on the presence of a VALUE parameter.
michael@0:      * @param aDate a date
michael@0:      */
michael@0:     public DtEnd(final Date aDate) {
michael@0:         super(DTEND, PropertyFactoryImpl.getInstance());
michael@0:         setDate(aDate);
michael@0:     }
michael@0: 
michael@0:     /**
michael@0:      * Constructs a new DtEnd with the specified time.
michael@0:      * @param time the time of the DtEnd
michael@0:      * @param utc specifies whether time is UTC
michael@0:      */
michael@0:     public DtEnd(final Date time, final boolean utc) {
michael@0:         super(DTEND, PropertyFactoryImpl.getInstance());
michael@0:         setDate(time);
michael@0:         setUtc(utc);
michael@0:     }
michael@0: 
michael@0:     /**
michael@0:      * Constructor. Date or Date-Time format is determined based on the presence of a VALUE parameter.
michael@0:      * @param aList a list of parameters for this component
michael@0:      * @param aDate a date
michael@0:      */
michael@0:     public DtEnd(final ParameterList aList, final Date aDate) {
michael@0:         super(DTEND, aList, PropertyFactoryImpl.getInstance());
michael@0:         setDate(aDate);
michael@0:     }
michael@0: 
michael@0:     /**
michael@0:      * {@inheritDoc}
michael@0:      */
michael@0:     public final void validate() throws ValidationException {
michael@0:         super.validate();
michael@0: 
michael@0:         /*
michael@0:          * ; the following are optional, ; but MUST NOT occur more than once (";" "VALUE" "=" ("DATE-TIME" / "DATE")) /
michael@0:          * (";" tzidparam) /
michael@0:          */
michael@0: 
michael@0:         /*
michael@0:          * ; the following is optional, ; and MAY occur more than once (";" xparam)
michael@0:          */
michael@0:     }
michael@0: }