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.util.Date;
michael@0: 
michael@0: import net.fortuna.ical4j.model.Dur;
michael@0: import net.fortuna.ical4j.model.ParameterList;
michael@0: import net.fortuna.ical4j.model.Property;
michael@0: import net.fortuna.ical4j.model.PropertyFactoryImpl;
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 DURATION iCalendar component property.
michael@0:  * 
michael@0:  * <pre>
michael@0:  *     4.3.6   Duration
michael@0:  *     
michael@0:  *        Value Name: DURATION
michael@0:  *     
michael@0:  *        Purpose: This value type is used to identify properties that contain
michael@0:  *        a duration of time.
michael@0:  *     
michael@0:  *        Formal Definition: The value type is defined by the following
michael@0:  *        notation:
michael@0:  *     
michael@0:  *          dur-value  = ([&quot;+&quot;] / &quot;-&quot;) &quot;P&quot; (dur-date / dur-time / dur-week)
michael@0:  *     
michael@0:  *          dur-date   = dur-day [dur-time]
michael@0:  *          dur-time   = &quot;T&quot; (dur-hour / dur-minute / dur-second)
michael@0:  *          dur-week   = 1*DIGIT &quot;W&quot;
michael@0:  *          dur-hour   = 1*DIGIT &quot;H&quot; [dur-minute]
michael@0:  *          dur-minute = 1*DIGIT &quot;M&quot; [dur-second]
michael@0:  *          dur-second = 1*DIGIT &quot;S&quot;
michael@0:  *          dur-day    = 1*DIGIT &quot;D&quot;
michael@0:  *     
michael@0:  *        Description: If the property permits, multiple &quot;duration&quot; values are
michael@0:  *        specified by a COMMA character (US-ASCII decimal 44) separated list
michael@0:  *        of values. The format is expressed as the [ISO 8601] basic format for
michael@0:  *        the duration of time. The format can represent durations in terms of
michael@0:  *        weeks, days, hours, minutes, and seconds.
michael@0:  *     
michael@0:  *        No additional content value encoding (i.e., BACKSLASH character
michael@0:  *        encoding) are defined for this value type.
michael@0:  *     
michael@0:  *        Example: A duration of 15 days, 5 hours and 20 seconds would be:
michael@0:  *     
michael@0:  *          P15DT5H0M20S
michael@0:  *     
michael@0:  *        A duration of 7 weeks would be:
michael@0:  *     
michael@0:  *          P7W
michael@0:  * </pre>
michael@0:  * 
michael@0:  * @author Ben Fortuna
michael@0:  */
michael@0: public class Duration extends Property {
michael@0: 
michael@0:     private static final long serialVersionUID = 9144969653829796798L;
michael@0: 
michael@0:     private Dur duration;
michael@0: 
michael@0:     /**
michael@0:      * Default constructor.
michael@0:      */
michael@0:     public Duration() {
michael@0:         super(DURATION, PropertyFactoryImpl.getInstance());
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:      */
michael@0:     public Duration(final ParameterList aList, final String aValue) {
michael@0:         super(DURATION, aList, PropertyFactoryImpl.getInstance());
michael@0:         setValue(aValue);
michael@0:     }
michael@0: 
michael@0:     /**
michael@0:      * @param duration a duration  value
michael@0:      */
michael@0:     public Duration(final Dur duration) {
michael@0:         super(DURATION, PropertyFactoryImpl.getInstance());
michael@0:         this.duration = duration;
michael@0:     }
michael@0: 
michael@0:     /**
michael@0:      * @param aList a list of parameters for this component
michael@0:      * @param duration a duration value
michael@0:      */
michael@0:     public Duration(final ParameterList aList, final Dur duration) {
michael@0:         super(DURATION, aList, PropertyFactoryImpl.getInstance());
michael@0:         setDuration(duration);
michael@0:     }
michael@0: 
michael@0:     /**
michael@0:      * Constructs a new duration representing the time between the specified start date and end date.
michael@0:      * @param start the starting time for the duration
michael@0:      * @param end the end time for the duration
michael@0:      */
michael@0:     public Duration(final Date start, final Date end) {
michael@0:         super(DURATION, PropertyFactoryImpl.getInstance());
michael@0:         setDuration(new Dur(start, end));
michael@0:     }
michael@0: 
michael@0:     /**
michael@0:      * @return Returns the duration.
michael@0:      */
michael@0:     public final Dur getDuration() {
michael@0:         return duration;
michael@0:     }
michael@0: 
michael@0:     /**
michael@0:      * {@inheritDoc}
michael@0:      */
michael@0:     public final void setValue(final String aValue) {
michael@0:         // duration = DurationFormat.getInstance().parse(aValue);
michael@0:         duration = new Dur(aValue);
michael@0:     }
michael@0: 
michael@0:     /**
michael@0:      * {@inheritDoc}
michael@0:      */
michael@0:     public final String getValue() {
michael@0:         // return DurationFormat.getInstance().format(getDuration());
michael@0:         return duration.toString();
michael@0:     }
michael@0: 
michael@0:     /**
michael@0:      * @param duration The duration to set.
michael@0:      */
michael@0:     public final void setDuration(final Dur duration) {
michael@0:         this.duration = duration;
michael@0:     }
michael@0: 
michael@0:     /**
michael@0:      * {@inheritDoc}
michael@0:      */
michael@0:     public final void validate() throws ValidationException {
michael@0:         // TODO: Auto-generated method stub
michael@0:     }
michael@0: }