net.fortuna.ical4j.model.property.DtEnd Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of ical4j Show documentation
A Java library for reading and writing iCalendar (*.ics) files
There is a newer version: 4.0.8
/**
 * Copyright (c) 2012, 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 net.fortuna.ical4j.model.Content;
import net.fortuna.ical4j.model.ParameterList;
import net.fortuna.ical4j.model.PropertyFactory;

import java.time.temporal.Temporal;

/**
 * $Id$
 * 
 * Created: [Apr 6, 2004]
 * 

 * Defines a DTEND iCalendar component property.
 * 

 * 
 *     4.8.2.2 Date/Time End
 *
 *        Property Name: DTEND
 *
 *        Purpose: This property specifies the date and time that a calendar
 *        component ends.
 *
 *        Value Type: The default value type is DATE-TIME. The value type can
 *        be set to a DATE value type.
 *
 *        Property Parameters: Non-standard, value data type, time zone
 *        identifier property parameters can be specified on this property.
 *
 *        Conformance: This property can be specified in "VEVENT" or
 *        "VFREEBUSY" calendar components.
 *
 *        Description: Within the "VEVENT" calendar component, this property
 *        defines the date and time by which the event ends. The value MUST be
 *        later in time than the value of the "DTSTART" property.
 *
 *        Within the "VFREEBUSY" calendar component, this property defines the
 *        end date and time for the free or busy time information. The time
 *        MUST be specified in the UTC time format. The value MUST be later in
 *        time than the value of the "DTSTART" property.
 *
 *        Format Definition: The property is defined by the following notation:
 *
 *          dtend      = "DTEND" dtendparam":" dtendval CRLF
 *
 *          dtendparam = *(
 *
 *                     ; the following are optional,
 *                     ; but MUST NOT occur more than once
 *
 *                     (";" "VALUE" "=" ("DATE-TIME" / "DATE")) /
 *                     (";" tzidparam) /
 *
 *                     ; the following is optional,
 *                     ; and MAY occur more than once
 *
 *                     (";" xparam)
 *
 *                     )
 *
 *
 *
 *          dtendval   = date-time / date
 *          ;Value MUST match value type
 * 
 * 
 * Examples:
 * 

 * 
 *      // construct an end date from a start date and a duration..
 *      DtStart start = ...
 *      Dur oneWeek = new Dur("1W");
 *      DtEnd end = new DtEnd(oneWeek.getTime(start.getDate());
 * 
 *
 * @author Ben Fortuna
 */
public class DtEnd extends DateProperty {

    private static final long serialVersionUID = 8107416684717228297L;

    /**
     * Default constructor. The time value is initialised to the time of instantiation.
     */
    public DtEnd() {
        super(DTEND);
    }

    /**
     * Creates a new instance initialised with the parsed value.
     *
     * @param value the DTEND value string to parse
     */
    public DtEnd(final String value) {
        super(DTEND);
        setValue(value);
    }

    /**
     * @param aList  a list of parameters for this component
     * @param aValue a value string for this component
     */
    public DtEnd(final ParameterList aList, final String aValue) {
        super(DTEND, aList);
        setValue(aValue);
    }

    /**
     * Constructor. Date or Date-Time format is determined based on the presence of a VALUE parameter.
     *
     * @param aDate a date
     */
    public DtEnd(final T aDate) {
        super(DTEND);
        setDate(aDate);
    }

    /**
     * Constructs a new DtEnd with the specified time.
     *
     * @param time the time of the DtEnd
     * @param utc  specifies whether time is UTC
     * @deprecated UTC time is now specified via the generic type (i.e. {@link java.time.Instant})
     */
    @Deprecated
    public DtEnd(final T time, final boolean utc) {
        this(time);
    }

    /**
     * Constructor. Date or Date-Time format is determined based on the presence of a VALUE parameter.
     *
     * @param aList a list of parameters for this component
     * @param aDate a date
     */
    public DtEnd(final ParameterList aList, final T aDate) {
        super(DTEND, aList);
        setDate(aDate);
    }

    @Override
    protected PropertyFactory> newFactory() {
        return new Factory<>();
    }

    public static class Factory extends Content.Factory implements PropertyFactory> {
        private static final long serialVersionUID = 1L;

        public Factory() {
            super(DTEND);
        }

        @Override
        public DtEnd createProperty(final ParameterList parameters, final String value) {
            return new DtEnd<>(parameters, value);
        }

        @Override
        public DtEnd createProperty() {
            return new DtEnd<>();
        }
    }

}