michael@0: /**
michael@0:  * Copyright (c) 2012, Ben Fortuna
michael@0:  * All rights reserved.
michael@0:  *
michael@0:  * Redistribution and use in source and binary forms, with or without
michael@0:  * modification, are permitted provided that the following conditions
michael@0:  * are met:
michael@0:  *
michael@0:  *  o Redistributions of source code must retain the above copyright
michael@0:  * notice, this list of conditions and the following disclaimer.
michael@0:  *
michael@0:  *  o Redistributions in binary form must reproduce the above copyright
michael@0:  * notice, this list of conditions and the following disclaimer in the
michael@0:  * documentation and/or other materials provided with the distribution.
michael@0:  *
michael@0:  *  o Neither the name of Ben Fortuna nor the names of any other contributors
michael@0:  * may be used to endorse or promote products derived from this software
michael@0:  * without specific prior written permission.
michael@0:  *
michael@0:  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
michael@0:  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
michael@0:  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
michael@0:  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
michael@0:  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
michael@0:  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
michael@0:  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
michael@0:  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
michael@0:  * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
michael@0:  * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
michael@0:  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
michael@0:  */
michael@0: package net.fortuna.ical4j.model.component;
michael@0: 
michael@0: import net.fortuna.ical4j.model.Component;
michael@0: import net.fortuna.ical4j.model.PropertyList;
michael@0: import net.fortuna.ical4j.model.ValidationException;
michael@0: import net.fortuna.ical4j.model.Validator;
michael@0: import net.fortuna.ical4j.model.property.Method;
michael@0: 
michael@0: /**
michael@0:  * $Id$
michael@0:  *
michael@0:  * Created on 26/02/2006
michael@0:  *
michael@0:  * Base class for components that may be added to a calendar.
michael@0:  * @author Ben Fortuna
michael@0:  */
michael@0: public abstract class CalendarComponent extends Component {
michael@0: 
michael@0:     /**
michael@0:      * 
michael@0:      */
michael@0:     private static final long serialVersionUID = -5832972592377720592L;
michael@0:     
michael@0:     /**
michael@0:      * Validator instance that does nothing.
michael@0:      */
michael@0:     protected static final Validator EMPTY_VALIDATOR = new EmptyValidator();
michael@0:     
michael@0:     /**
michael@0:      * @param name component name
michael@0:      */
michael@0:     public CalendarComponent(final String name) {
michael@0:         super(name);
michael@0:     }
michael@0: 
michael@0:     /**
michael@0:      * @param name component name
michael@0:      * @param properties component properties
michael@0:      */
michael@0:     public CalendarComponent(final String name, final PropertyList properties) {
michael@0:         super(name, properties);
michael@0:     }
michael@0: 
michael@0:     /**
michael@0:      * Performs method-specific ITIP validation.
michael@0:      * @param method the applicable method
michael@0:      * @throws ValidationException where the component does not comply with RFC2446
michael@0:      */
michael@0:     public final void validate(Method method) throws ValidationException {
michael@0:         final Validator validator = getValidator(method);
michael@0:         if (validator != null) {
michael@0:             validator.validate();
michael@0:         }
michael@0:         else {
michael@0:             throw new ValidationException("Unsupported method: " + method);
michael@0:         }
michael@0:     }
michael@0: 
michael@0:     /**
michael@0:      * @param method a method to validate on
michael@0:      * @return a validator for the specified method or null if the method is not supported
michael@0:      */
michael@0:     protected abstract Validator getValidator(Method method);
michael@0:     
michael@0:     /**
michael@0:      * Apply validation for METHOD=PUBLISH.
michael@0:      * @throws ValidationException where the component does not comply with RFC2446
michael@0:      * @deprecated
michael@0:      */
michael@0:     public final void validatePublish() throws ValidationException {
michael@0:         validate(Method.PUBLISH);
michael@0:     }
michael@0: 
michael@0:     /**
michael@0:      * Apply validation for METHOD=REQUEST.
michael@0:      * @throws ValidationException where the component does not comply with RFC2446
michael@0:      * @deprecated
michael@0:      */
michael@0:     public final void validateRequest() throws ValidationException {
michael@0:         validate(Method.REQUEST);
michael@0:     }
michael@0: 
michael@0:     /**
michael@0:      * Apply validation for METHOD=REPLY.
michael@0:      * @throws ValidationException where the component does not comply with RFC2446
michael@0:      * @deprecated
michael@0:      */
michael@0:     public final void validateReply() throws ValidationException {
michael@0:         validate(Method.REPLY);
michael@0:     }
michael@0: 
michael@0:     /**
michael@0:      * Apply validation for METHOD=ADD.
michael@0:      * @throws ValidationException where the component does not comply with RFC2446
michael@0:      * @deprecated
michael@0:      */
michael@0:     public final void validateAdd() throws ValidationException {
michael@0:         validate(Method.ADD);
michael@0:     }
michael@0: 
michael@0:     /**
michael@0:      * Apply validation for METHOD=CANCEL.
michael@0:      * @throws ValidationException where the component does not comply with RFC2446
michael@0:      * @deprecated
michael@0:      */
michael@0:     public final void validateCancel() throws ValidationException {
michael@0:         validate(Method.CANCEL);
michael@0:     }
michael@0: 
michael@0:     /**
michael@0:      * Apply validation for METHOD=REFRESH.
michael@0:      * @throws ValidationException where the component does not comply with RFC2446
michael@0:      * @deprecated
michael@0:      */
michael@0:     public final void validateRefresh() throws ValidationException {
michael@0:         validate(Method.REFRESH);
michael@0:     }
michael@0: 
michael@0:     /**
michael@0:      * Apply validation for METHOD=COUNTER.
michael@0:      * @throws ValidationException where the component does not comply with RFC2446
michael@0:      * @deprecated
michael@0:      */
michael@0:     public final void validateCounter() throws ValidationException {
michael@0:         validate(Method.COUNTER);
michael@0:     }
michael@0: 
michael@0:     /**
michael@0:      * Apply validation for METHOD=DECLINE-COUNTER.
michael@0:      * @throws ValidationException where the component does not comply with RFC2446
michael@0:      * @deprecated
michael@0:      */
michael@0:     public final void validateDeclineCounter() throws ValidationException {
michael@0:         validate(Method.DECLINE_COUNTER);
michael@0:     }
michael@0:     
michael@0:     private static class EmptyValidator implements Validator {
michael@0:         
michael@0: 		private static final long serialVersionUID = 1L;
michael@0: 
michael@0:         public void validate() throws ValidationException {
michael@0:             // TODO Auto-generated method stub
michael@0:             
michael@0:         }
michael@0:     }
michael@0: }