1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/src/net/fortuna/ical4j/model/property/UtcProperty.java Tue Feb 10 18:12:00 2015 +0100
1.3 @@ -0,0 +1,119 @@
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 net.fortuna.ical4j.model.DateTime;
1.38 +import net.fortuna.ical4j.model.ParameterList;
1.39 +import net.fortuna.ical4j.model.PropertyFactory;
1.40 +import net.fortuna.ical4j.model.TimeZone;
1.41 +import net.fortuna.ical4j.model.ValidationException;
1.42 +
1.43 +/**
1.44 + * $Id$
1.45 + *
1.46 + * Created on 8/08/2005
1.47 + *
1.48 + * Superclass for all properties with date-time values that must be specified in UTC time.
1.49 + * @author Ben Fortuna
1.50 + */
1.51 +public abstract class UtcProperty extends DateProperty {
1.52 +
1.53 + /**
1.54 + *
1.55 + */
1.56 + private static final long serialVersionUID = 4850079486497487938L;
1.57 +
1.58 + /**
1.59 + * @param name a property name
1.60 + * @param parameters list of parameters
1.61 + */
1.62 + public UtcProperty(final String name, final ParameterList parameters, PropertyFactory factory) {
1.63 + super(name, parameters, factory);
1.64 + setDate(new DateTime(true));
1.65 + }
1.66 +
1.67 + /**
1.68 + * @param name a property name
1.69 + */
1.70 + public UtcProperty(final String name, PropertyFactory factory) {
1.71 + super(name, factory);
1.72 + setDate(new DateTime(true));
1.73 + }
1.74 +
1.75 + /**
1.76 + * @return Returns the date-time.
1.77 + */
1.78 + public final DateTime getDateTime() {
1.79 + return (DateTime) getDate();
1.80 + }
1.81 +
1.82 + /**
1.83 + * @param dateTime The dateTime to set.
1.84 + */
1.85 + public void setDateTime(final DateTime dateTime) {
1.86 + // time must be in UTC..
1.87 + if (dateTime != null) {
1.88 + final DateTime utcDateTime = new DateTime(dateTime);
1.89 + utcDateTime.setUtc(true);
1.90 + setDate(utcDateTime);
1.91 + }
1.92 + else {
1.93 + setDate(dateTime);
1.94 + }
1.95 + }
1.96 +
1.97 + /**
1.98 + * {@inheritDoc}
1.99 + */
1.100 + public void setTimeZone(TimeZone timezone) {
1.101 + throw new UnsupportedOperationException("Cannot set timezone for UTC properties");
1.102 + }
1.103 +
1.104 + /**
1.105 + * {@inheritDoc}
1.106 + */
1.107 + public void validate() throws ValidationException {
1.108 + super.validate();
1.109 +
1.110 + if (getDate() != null && !(getDate() instanceof DateTime)) {
1.111 + throw new ValidationException(
1.112 + "Property must have a DATE-TIME value");
1.113 + }
1.114 +
1.115 + final DateTime dateTime = (DateTime) getDate();
1.116 +
1.117 + if (dateTime != null && !dateTime.isUtc()) {
1.118 + throw new ValidationException(getName() +
1.119 + ": DATE-TIME value must be specified in UTC time");
1.120 + }
1.121 + }
1.122 +}
