src/net/fortuna/ical4j/model/component/CalendarComponent.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.component;
michael@0 33
michael@0 34 import net.fortuna.ical4j.model.Component;
michael@0 35 import net.fortuna.ical4j.model.PropertyList;
michael@0 36 import net.fortuna.ical4j.model.ValidationException;
michael@0 37 import net.fortuna.ical4j.model.Validator;
michael@0 38 import net.fortuna.ical4j.model.property.Method;
michael@0 39
michael@0 40 /**
michael@0 41 * $Id$
michael@0 42 *
michael@0 43 * Created on 26/02/2006
michael@0 44 *
michael@0 45 * Base class for components that may be added to a calendar.
michael@0 46 * @author Ben Fortuna
michael@0 47 */
michael@0 48 public abstract class CalendarComponent extends Component {
michael@0 49
michael@0 50 /**
michael@0 51 *
michael@0 52 */
michael@0 53 private static final long serialVersionUID = -5832972592377720592L;
michael@0 54
michael@0 55 /**
michael@0 56 * Validator instance that does nothing.
michael@0 57 */
michael@0 58 protected static final Validator EMPTY_VALIDATOR = new EmptyValidator();
michael@0 59
michael@0 60 /**
michael@0 61 * @param name component name
michael@0 62 */
michael@0 63 public CalendarComponent(final String name) {
michael@0 64 super(name);
michael@0 65 }
michael@0 66
michael@0 67 /**
michael@0 68 * @param name component name
michael@0 69 * @param properties component properties
michael@0 70 */
michael@0 71 public CalendarComponent(final String name, final PropertyList properties) {
michael@0 72 super(name, properties);
michael@0 73 }
michael@0 74
michael@0 75 /**
michael@0 76 * Performs method-specific ITIP validation.
michael@0 77 * @param method the applicable method
michael@0 78 * @throws ValidationException where the component does not comply with RFC2446
michael@0 79 */
michael@0 80 public final void validate(Method method) throws ValidationException {
michael@0 81 final Validator validator = getValidator(method);
michael@0 82 if (validator != null) {
michael@0 83 validator.validate();
michael@0 84 }
michael@0 85 else {
michael@0 86 throw new ValidationException("Unsupported method: " + method);
michael@0 87 }
michael@0 88 }
michael@0 89
michael@0 90 /**
michael@0 91 * @param method a method to validate on
michael@0 92 * @return a validator for the specified method or null if the method is not supported
michael@0 93 */
michael@0 94 protected abstract Validator getValidator(Method method);
michael@0 95
michael@0 96 /**
michael@0 97 * Apply validation for METHOD=PUBLISH.
michael@0 98 * @throws ValidationException where the component does not comply with RFC2446
michael@0 99 * @deprecated
michael@0 100 */
michael@0 101 public final void validatePublish() throws ValidationException {
michael@0 102 validate(Method.PUBLISH);
michael@0 103 }
michael@0 104
michael@0 105 /**
michael@0 106 * Apply validation for METHOD=REQUEST.
michael@0 107 * @throws ValidationException where the component does not comply with RFC2446
michael@0 108 * @deprecated
michael@0 109 */
michael@0 110 public final void validateRequest() throws ValidationException {
michael@0 111 validate(Method.REQUEST);
michael@0 112 }
michael@0 113
michael@0 114 /**
michael@0 115 * Apply validation for METHOD=REPLY.
michael@0 116 * @throws ValidationException where the component does not comply with RFC2446
michael@0 117 * @deprecated
michael@0 118 */
michael@0 119 public final void validateReply() throws ValidationException {
michael@0 120 validate(Method.REPLY);
michael@0 121 }
michael@0 122
michael@0 123 /**
michael@0 124 * Apply validation for METHOD=ADD.
michael@0 125 * @throws ValidationException where the component does not comply with RFC2446
michael@0 126 * @deprecated
michael@0 127 */
michael@0 128 public final void validateAdd() throws ValidationException {
michael@0 129 validate(Method.ADD);
michael@0 130 }
michael@0 131
michael@0 132 /**
michael@0 133 * Apply validation for METHOD=CANCEL.
michael@0 134 * @throws ValidationException where the component does not comply with RFC2446
michael@0 135 * @deprecated
michael@0 136 */
michael@0 137 public final void validateCancel() throws ValidationException {
michael@0 138 validate(Method.CANCEL);
michael@0 139 }
michael@0 140
michael@0 141 /**
michael@0 142 * Apply validation for METHOD=REFRESH.
michael@0 143 * @throws ValidationException where the component does not comply with RFC2446
michael@0 144 * @deprecated
michael@0 145 */
michael@0 146 public final void validateRefresh() throws ValidationException {
michael@0 147 validate(Method.REFRESH);
michael@0 148 }
michael@0 149
michael@0 150 /**
michael@0 151 * Apply validation for METHOD=COUNTER.
michael@0 152 * @throws ValidationException where the component does not comply with RFC2446
michael@0 153 * @deprecated
michael@0 154 */
michael@0 155 public final void validateCounter() throws ValidationException {
michael@0 156 validate(Method.COUNTER);
michael@0 157 }
michael@0 158
michael@0 159 /**
michael@0 160 * Apply validation for METHOD=DECLINE-COUNTER.
michael@0 161 * @throws ValidationException where the component does not comply with RFC2446
michael@0 162 * @deprecated
michael@0 163 */
michael@0 164 public final void validateDeclineCounter() throws ValidationException {
michael@0 165 validate(Method.DECLINE_COUNTER);
michael@0 166 }
michael@0 167
michael@0 168 private static class EmptyValidator implements Validator {
michael@0 169
michael@0 170 private static final long serialVersionUID = 1L;
michael@0 171
michael@0 172 public void validate() throws ValidationException {
michael@0 173 // TODO Auto-generated method stub
michael@0 174
michael@0 175 }
michael@0 176 }
michael@0 177 }

mercurial