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

Tue, 10 Feb 2015 18:12:00 +0100

author
Michael Schloh von Bennewitz <michael@schloh.com>
date
Tue, 10 Feb 2015 18:12:00 +0100
changeset 0
fb9019fb1bf7
permissions
-rw-r--r--

Import initial revisions of existing project AndroidCaldavSyncAdapater,
forked from upstream repository at 27e8a0f8495c92e0780d450bdf0c7cec77a03a55.

michael@0 1 /**
michael@0 2 * Copyright (c) 2012, Ben Fortuna
michael@0 3 * All rights reserved.
michael@0 4 *
michael@0 5 * Redistribution and use in source and binary forms, with or without
michael@0 6 * modification, are permitted provided that the following conditions
michael@0 7 * are met:
michael@0 8 *
michael@0 9 * o Redistributions of source code must retain the above copyright
michael@0 10 * notice, this list of conditions and the following disclaimer.
michael@0 11 *
michael@0 12 * o Redistributions in binary form must reproduce the above copyright
michael@0 13 * notice, this list of conditions and the following disclaimer in the
michael@0 14 * documentation and/or other materials provided with the distribution.
michael@0 15 *
michael@0 16 * o Neither the name of Ben Fortuna nor the names of any other contributors
michael@0 17 * may be used to endorse or promote products derived from this software
michael@0 18 * without specific prior written permission.
michael@0 19 *
michael@0 20 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
michael@0 21 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
michael@0 22 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
michael@0 23 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
michael@0 24 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
michael@0 25 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
michael@0 26 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
michael@0 27 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
michael@0 28 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
michael@0 29 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
michael@0 30 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
michael@0 31 */
michael@0 32 package net.fortuna.ical4j.model.property;
michael@0 33
michael@0 34 import net.fortuna.ical4j.model.DateTime;
michael@0 35 import net.fortuna.ical4j.model.ParameterList;
michael@0 36 import net.fortuna.ical4j.model.PropertyFactory;
michael@0 37 import net.fortuna.ical4j.model.TimeZone;
michael@0 38 import net.fortuna.ical4j.model.ValidationException;
michael@0 39
michael@0 40 /**
michael@0 41 * $Id$
michael@0 42 *
michael@0 43 * Created on 8/08/2005
michael@0 44 *
michael@0 45 * Superclass for all properties with date-time values that must be specified in UTC time.
michael@0 46 * @author Ben Fortuna
michael@0 47 */
michael@0 48 public abstract class UtcProperty extends DateProperty {
michael@0 49
michael@0 50 /**
michael@0 51 *
michael@0 52 */
michael@0 53 private static final long serialVersionUID = 4850079486497487938L;
michael@0 54
michael@0 55 /**
michael@0 56 * @param name a property name
michael@0 57 * @param parameters list of parameters
michael@0 58 */
michael@0 59 public UtcProperty(final String name, final ParameterList parameters, PropertyFactory factory) {
michael@0 60 super(name, parameters, factory);
michael@0 61 setDate(new DateTime(true));
michael@0 62 }
michael@0 63
michael@0 64 /**
michael@0 65 * @param name a property name
michael@0 66 */
michael@0 67 public UtcProperty(final String name, PropertyFactory factory) {
michael@0 68 super(name, factory);
michael@0 69 setDate(new DateTime(true));
michael@0 70 }
michael@0 71
michael@0 72 /**
michael@0 73 * @return Returns the date-time.
michael@0 74 */
michael@0 75 public final DateTime getDateTime() {
michael@0 76 return (DateTime) getDate();
michael@0 77 }
michael@0 78
michael@0 79 /**
michael@0 80 * @param dateTime The dateTime to set.
michael@0 81 */
michael@0 82 public void setDateTime(final DateTime dateTime) {
michael@0 83 // time must be in UTC..
michael@0 84 if (dateTime != null) {
michael@0 85 final DateTime utcDateTime = new DateTime(dateTime);
michael@0 86 utcDateTime.setUtc(true);
michael@0 87 setDate(utcDateTime);
michael@0 88 }
michael@0 89 else {
michael@0 90 setDate(dateTime);
michael@0 91 }
michael@0 92 }
michael@0 93
michael@0 94 /**
michael@0 95 * {@inheritDoc}
michael@0 96 */
michael@0 97 public void setTimeZone(TimeZone timezone) {
michael@0 98 throw new UnsupportedOperationException("Cannot set timezone for UTC properties");
michael@0 99 }
michael@0 100
michael@0 101 /**
michael@0 102 * {@inheritDoc}
michael@0 103 */
michael@0 104 public void validate() throws ValidationException {
michael@0 105 super.validate();
michael@0 106
michael@0 107 if (getDate() != null && !(getDate() instanceof DateTime)) {
michael@0 108 throw new ValidationException(
michael@0 109 "Property must have a DATE-TIME value");
michael@0 110 }
michael@0 111
michael@0 112 final DateTime dateTime = (DateTime) getDate();
michael@0 113
michael@0 114 if (dateTime != null && !dateTime.isUtc()) {
michael@0 115 throw new ValidationException(getName() +
michael@0 116 ": DATE-TIME value must be specified in UTC time");
michael@0 117 }
michael@0 118 }
michael@0 119 }

mercurial