Duration.java

/*
 * $Id: Duration.java,v 1.10 2006/02/26 07:48:11 fortuna Exp $
 * 
 * Created: [Apr 6, 2004]
 *
 * Copyright (c) 2004, Ben Fortuna
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 *  o Redistributions of source code must retain the above copyright
 * notice, this list of conditions and the following disclaimer.
 *
 *  o Redistributions in binary form must reproduce the above copyright
 * notice, this list of conditions and the following disclaimer in the
 * documentation and/or other materials provided with the distribution.
 *
 *  o Neither the name of Ben Fortuna nor the names of any other contributors
 * may be used to endorse or promote products derived from this software
 * without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
package net.fortuna.ical4j.model.property;

import java.util.Date;

import net.fortuna.ical4j.model.Dur;
import net.fortuna.ical4j.model.ParameterList;
import net.fortuna.ical4j.model.Property;
import net.fortuna.ical4j.model.ValidationException;

/**
 * Defines a DURATION iCalendar component property.
 * 
 * <pre>
 * 4.3.6   Duration
 * 
 *    Value Name: DURATION
 * 
 *    Purpose: This value type is used to identify properties that contain
 *    a duration of time.
 * 
 *    Formal Definition: The value type is defined by the following
 *    notation:
 * 
 *      dur-value  = (["+"] / "-") "P" (dur-date / dur-time / dur-week)
 * 
 *      dur-date   = dur-day [dur-time]
 *      dur-time   = "T" (dur-hour / dur-minute / dur-second)
 *      dur-week   = 1*DIGIT "W"
 *      dur-hour   = 1*DIGIT "H" [dur-minute]
 *      dur-minute = 1*DIGIT "M" [dur-second]
 *      dur-second = 1*DIGIT "S"
 *      dur-day    = 1*DIGIT "D"
 * 
 *    Description: If the property permits, multiple "duration" values are
 *    specified by a COMMA character (US-ASCII decimal 44) separated list
 *    of values. The format is expressed as the [ISO 8601] basic format for
 *    the duration of time. The format can represent durations in terms of
 *    weeks, days, hours, minutes, and seconds.
 * 
 *    No additional content value encoding (i.e., BACKSLASH character
 *    encoding) are defined for this value type.
 * 
 *    Example: A duration of 15 days, 5 hours and 20 seconds would be:
 * 
 *      P15DT5H0M20S
 * 
 *    A duration of 7 weeks would be:
 * 
 *      P7W
 * </pre>
 *
 * @author Ben Fortuna
 */
public class Duration extends Property {
    
    private static final long serialVersionUID = 9144969653829796798L;

    private Dur duration;

    /**
     * Default constructor.
     */
    public Duration() {
        super(DURATION);
    }
    
    /**
     * @param aList
     *            a list of parameters for this component
     * @param aValue
     *            a value string for this component
     */
    public Duration(final ParameterList aList, final String aValue) {
        super(DURATION, aList);
        setValue(aValue);
    }
    
    /**
     * @param duration
     */
    public Duration(final Dur duration) {
        super(DURATION);
        this.duration = duration;
    }

    /**
     * @param aList
     *            a list of parameters for this component
     * @param aDuration
     *            a duration specified in milliseconds
     */
    public Duration(final ParameterList aList, final Dur duration) {
        super(DURATION, aList);
        setDuration(duration);
    }
    
    /**
     * Constructs a new duration representing the time
     * between the specified start date and end date.
     * @param start the starting time for the duration
     * @param end the end time for the duration
     */
    public Duration(final Date start, final Date end) {
        super(DURATION);
        setDuration(new Dur(start, end));
    }

    /**
     * @return Returns the duration.
     */
    public final Dur getDuration() {
        return duration;
    }
    
    
    /* (non-Javadoc)
     * @see net.fortuna.ical4j.model.Property#setValue(java.lang.String)
     */
    public final void setValue(final String aValue) {
//        duration = DurationFormat.getInstance().parse(aValue);
        duration = new Dur(aValue);
    }

    /*
     * (non-Javadoc)
     *
     * @see net.fortuna.ical4j.model.Property#getValue()
     */
    public final String getValue() {
//        return DurationFormat.getInstance().format(getDuration());
        return duration.toString();
    }
    
    /**
     * @param duration The duration to set.
     */
    public final void setDuration(final Dur duration) {
        this.duration = duration;
    }
    
    /* (non-Javadoc)
     * @see net.fortuna.ical4j.model.Property#validate()
     */
    public final void validate() throws ValidationException {
        // TODO: Auto-generated method stub
    }
}