src/net/fortuna/ical4j/model/property/Completed.java

changeset 0
fb9019fb1bf7
     1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/src/net/fortuna/ical4j/model/property/Completed.java	Tue Feb 10 18:12:00 2015 +0100
     1.3 @@ -0,0 +1,125 @@
     1.4 +/**
     1.5 + * Copyright (c) 2012, Ben Fortuna
     1.6 + * All rights reserved.
     1.7 + *
     1.8 + * Redistribution and use in source and binary forms, with or without
     1.9 + * modification, are permitted provided that the following conditions
    1.10 + * are met:
    1.11 + *
    1.12 + *  o Redistributions of source code must retain the above copyright
    1.13 + * notice, this list of conditions and the following disclaimer.
    1.14 + *
    1.15 + *  o Redistributions in binary form must reproduce the above copyright
    1.16 + * notice, this list of conditions and the following disclaimer in the
    1.17 + * documentation and/or other materials provided with the distribution.
    1.18 + *
    1.19 + *  o Neither the name of Ben Fortuna nor the names of any other contributors
    1.20 + * may be used to endorse or promote products derived from this software
    1.21 + * without specific prior written permission.
    1.22 + *
    1.23 + * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
    1.24 + * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
    1.25 + * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
    1.26 + * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
    1.27 + * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
    1.28 + * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
    1.29 + * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
    1.30 + * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
    1.31 + * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
    1.32 + * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
    1.33 + * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
    1.34 + */
    1.35 +package net.fortuna.ical4j.model.property;
    1.36 +
    1.37 +import java.text.ParseException;
    1.38 +
    1.39 +import net.fortuna.ical4j.model.DateTime;
    1.40 +import net.fortuna.ical4j.model.ParameterList;
    1.41 +import net.fortuna.ical4j.model.PropertyFactoryImpl;
    1.42 +
    1.43 +/**
    1.44 + * $Id$
    1.45 + * 
    1.46 + * Created: [Apr 6, 2004]
    1.47 + *
    1.48 + * Defines a COMPLETED iCalendar component property.
    1.49 + * 
    1.50 + * <pre>
    1.51 + *     4.8.2.1 Date/Time Completed
    1.52 + *     
    1.53 + *        Property Name: COMPLETED
    1.54 + *     
    1.55 + *        Purpose: This property defines the date and time that a to-do was
    1.56 + *        actually completed.
    1.57 + *     
    1.58 + *        Value Type: DATE-TIME
    1.59 + *     
    1.60 + *        Property Parameters: Non-standard property parameters can be
    1.61 + *        specified on this property.
    1.62 + *     
    1.63 + *        Conformance: The property can be specified in a &quot;VTODO&quot; calendar
    1.64 + *        component.
    1.65 + *     
    1.66 + *        Description: The date and time MUST be in a UTC format.
    1.67 + *     
    1.68 + *        Format Definition: The property is defined by the following notation:
    1.69 + *     
    1.70 + *          completed  = &quot;COMPLETED&quot; compparam &quot;:&quot; date-time CRLF
    1.71 + *     
    1.72 + *          compparam  = *(&quot;;&quot; xparam)
    1.73 + * </pre>
    1.74 + * 
    1.75 + * @author Ben Fortuna
    1.76 + */
    1.77 +public class Completed extends UtcProperty {
    1.78 +
    1.79 +    private static final long serialVersionUID = 6824213281785639181L;
    1.80 +
    1.81 +    /**
    1.82 +     * Default constructor.
    1.83 +     */
    1.84 +    public Completed() {
    1.85 +        super(COMPLETED, PropertyFactoryImpl.getInstance());
    1.86 +    }
    1.87 +
    1.88 +    /**
    1.89 +     * @param aValue a value string for this component
    1.90 +     * @throws ParseException when the specified string is not a valid date-time represenation
    1.91 +     */
    1.92 +    public Completed(final String aValue) throws ParseException {
    1.93 +        super(COMPLETED, PropertyFactoryImpl.getInstance());
    1.94 +        setValue(aValue);
    1.95 +    }
    1.96 +
    1.97 +    /**
    1.98 +     * @param aList a list of parameters for this component
    1.99 +     * @param aValue a value string for this component
   1.100 +     * @throws ParseException when the specified string is not a valid date-time represenation
   1.101 +     */
   1.102 +    public Completed(final ParameterList aList, final String aValue)
   1.103 +            throws ParseException {
   1.104 +        super(COMPLETED, aList, PropertyFactoryImpl.getInstance());
   1.105 +        setValue(aValue);
   1.106 +    }
   1.107 +
   1.108 +    /**
   1.109 +     * @param aDate a date
   1.110 +     */
   1.111 +    public Completed(final DateTime aDate) {
   1.112 +        super(COMPLETED, PropertyFactoryImpl.getInstance());
   1.113 +        // time must be in UTC..
   1.114 +        aDate.setUtc(true);
   1.115 +        setDate(aDate);
   1.116 +    }
   1.117 +
   1.118 +    /**
   1.119 +     * @param aList a list of parameters for this component
   1.120 +     * @param aDate a date
   1.121 +     */
   1.122 +    public Completed(final ParameterList aList, final DateTime aDate) {
   1.123 +        super(COMPLETED, aList, PropertyFactoryImpl.getInstance());
   1.124 +        // time must be in UTC..
   1.125 +        aDate.setUtc(true);
   1.126 +        setDate(aDate);
   1.127 +    }
   1.128 +}

mercurial