src/net/fortuna/ical4j/model/property/DateListProperty.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 java.io.IOException;
michael@0 35 import java.net.URISyntaxException;
michael@0 36 import java.text.ParseException;
michael@0 37
michael@0 38 import net.fortuna.ical4j.model.DateList;
michael@0 39 import net.fortuna.ical4j.model.Parameter;
michael@0 40 import net.fortuna.ical4j.model.ParameterList;
michael@0 41 import net.fortuna.ical4j.model.Property;
michael@0 42 import net.fortuna.ical4j.model.PropertyFactory;
michael@0 43 import net.fortuna.ical4j.model.TimeZone;
michael@0 44 import net.fortuna.ical4j.model.parameter.TzId;
michael@0 45 import net.fortuna.ical4j.model.parameter.Value;
michael@0 46 import net.fortuna.ical4j.util.Strings;
michael@0 47
michael@0 48 /**
michael@0 49 * $Id$
michael@0 50 *
michael@0 51 * Created on 11/08/2005
michael@0 52 *
michael@0 53 * Base class for properties with a list of dates as a value.
michael@0 54 * @author Ben Fortuna
michael@0 55 */
michael@0 56 public abstract class DateListProperty extends Property {
michael@0 57
michael@0 58 /**
michael@0 59 *
michael@0 60 */
michael@0 61 private static final long serialVersionUID = 5233773091972759919L;
michael@0 62
michael@0 63 private DateList dates;
michael@0 64
michael@0 65 private TimeZone timeZone;
michael@0 66
michael@0 67 /**
michael@0 68 * @param name the property name
michael@0 69 */
michael@0 70 public DateListProperty(final String name, PropertyFactory factory) {
michael@0 71 this(name, new DateList(Value.DATE_TIME), factory);
michael@0 72 }
michael@0 73
michael@0 74 /**
michael@0 75 * @param name the property name
michael@0 76 * @param parameters property parameters
michael@0 77 */
michael@0 78 public DateListProperty(final String name, final ParameterList parameters, PropertyFactory factory) {
michael@0 79 super(name, parameters, factory);
michael@0 80 }
michael@0 81
michael@0 82 /**
michael@0 83 * @param name the property name
michael@0 84 * @param dates a list of initial dates for the property
michael@0 85 */
michael@0 86 public DateListProperty(final String name, final DateList dates, PropertyFactory factory) {
michael@0 87 this(name, new ParameterList(), dates, factory);
michael@0 88 }
michael@0 89
michael@0 90 /**
michael@0 91 * @param name the property name
michael@0 92 * @param parameters property parameters
michael@0 93 * @param dates a list of initial dates for the property
michael@0 94 */
michael@0 95 public DateListProperty(final String name, final ParameterList parameters, final DateList dates,
michael@0 96 PropertyFactory factory) {
michael@0 97 super(name, parameters, factory);
michael@0 98 this.dates = dates;
michael@0 99 if (dates != null && !Value.DATE_TIME.equals(dates.getType())) {
michael@0 100 getParameters().replace(dates.getType());
michael@0 101 }
michael@0 102 }
michael@0 103
michael@0 104 /**
michael@0 105 * @return Returns the dates.
michael@0 106 */
michael@0 107 public final DateList getDates() {
michael@0 108 return dates;
michael@0 109 }
michael@0 110
michael@0 111 /**
michael@0 112 * {@inheritDoc}
michael@0 113 */
michael@0 114 public void setValue(final String aValue) throws ParseException {
michael@0 115 dates = new DateList(aValue, (Value) getParameter(Parameter.VALUE),
michael@0 116 timeZone);
michael@0 117 }
michael@0 118
michael@0 119 /**
michael@0 120 * {@inheritDoc}
michael@0 121 */
michael@0 122 public String getValue() {
michael@0 123 return Strings.valueOf(dates);
michael@0 124 }
michael@0 125
michael@0 126 /**
michael@0 127 * Sets the timezone associated with this property.
michael@0 128 * @param timezone a timezone to associate with this property
michael@0 129 */
michael@0 130 public void setTimeZone(final TimeZone timezone) {
michael@0 131 if (dates == null) {
michael@0 132 throw new UnsupportedOperationException(
michael@0 133 "TimeZone is not applicable to current value");
michael@0 134 }
michael@0 135 this.timeZone = timezone;
michael@0 136 if (timezone != null) {
michael@0 137 if (!Value.DATE_TIME.equals(getDates().getType())) {
michael@0 138 throw new UnsupportedOperationException(
michael@0 139 "TimeZone is not applicable to current value");
michael@0 140 }
michael@0 141 dates.setTimeZone(timezone);
michael@0 142 getParameters().remove(getParameter(Parameter.TZID));
michael@0 143 final TzId tzId = new TzId(timezone.getID());
michael@0 144 getParameters().replace(tzId);
michael@0 145 }
michael@0 146 else {
michael@0 147 // use setUtc() to reset timezone..
michael@0 148 setUtc(false);
michael@0 149 }
michael@0 150 }
michael@0 151
michael@0 152 /**
michael@0 153 * @return the timezone
michael@0 154 */
michael@0 155 public final TimeZone getTimeZone() {
michael@0 156 return timeZone;
michael@0 157 }
michael@0 158
michael@0 159 /**
michael@0 160 * Resets the timezone associated with the property. If utc is true, any TZID parameters are removed and the Java
michael@0 161 * timezone is updated to UTC time. If utc is false, TZID parameters are removed and the Java timezone is set to the
michael@0 162 * default timezone (i.e. represents a "floating" local time)
michael@0 163 * @param utc the UTC value
michael@0 164 */
michael@0 165 public final void setUtc(final boolean utc) {
michael@0 166 if (dates == null || !Value.DATE_TIME.equals(dates.getType())) {
michael@0 167 throw new UnsupportedOperationException(
michael@0 168 "TimeZone is not applicable to current value");
michael@0 169 }
michael@0 170 dates.setUtc(utc);
michael@0 171 getParameters().remove(getParameter(Parameter.TZID));
michael@0 172 }
michael@0 173
michael@0 174 /**
michael@0 175 * {@inheritDoc}
michael@0 176 */
michael@0 177 public final Property copy() throws IOException, URISyntaxException, ParseException {
michael@0 178 final Property copy = super.copy();
michael@0 179
michael@0 180 ((DateListProperty) copy).timeZone = timeZone;
michael@0 181 ((DateListProperty) copy).setValue(getValue());
michael@0 182
michael@0 183 return copy;
michael@0 184 }
michael@0 185 }

mercurial