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.data;
michael@0: 
michael@0: import java.io.IOException;
michael@0: import java.net.URISyntaxException;
michael@0: import java.text.ParseException;
michael@0: 
michael@0: /**
michael@0:  * <pre>
michael@0:  * $Id$ [Nov 5,
michael@0:  * 2004]
michael@0:  * </pre>
michael@0:  *
michael@0:  * Implementors provide functionality applicable during the parsing of an iCalendar data stream (e.g. building an object
michael@0:  * model).
michael@0:  * @author Ben Fortuna
michael@0:  */
michael@0: public interface ContentHandler {
michael@0: 
michael@0:     /**
michael@0:      * Triggers the start of handling a calendar.
michael@0:      */
michael@0:     void startCalendar();
michael@0: 
michael@0:     /**
michael@0:      * Triggers the end of handling a calendar.
michael@0:      */
michael@0:     void endCalendar();
michael@0: 
michael@0:     /**
michael@0:      * Triggers the start of handling a component.
michael@0:      * @param name a component name
michael@0:      */
michael@0:     void startComponent(String name);
michael@0: 
michael@0:     /**
michael@0:      * Triggers the end of handling a component.
michael@0:      * @param name a component name
michael@0:      */
michael@0:     void endComponent(String name);
michael@0: 
michael@0:     /**
michael@0:      * Triggers the start of handling a property.
michael@0:      * @param name a property name
michael@0:      */
michael@0:     void startProperty(String name);
michael@0: 
michael@0:     /**
michael@0:      * Triggers the handling of a property value.
michael@0:      * @param value a property value
michael@0:      * @throws URISyntaxException where the property value is not a valid URI for applicable properties
michael@0:      * @throws ParseException where the date value cannot be parsed for applicable properties
michael@0:      * @throws IOException where data cannot be read for applicable properties
michael@0:      */
michael@0:     void propertyValue(String value) throws URISyntaxException, ParseException,
michael@0:             IOException;
michael@0: 
michael@0:     /**
michael@0:      * Triggers the end of handling a property.
michael@0:      * @param name a property name
michael@0:      */
michael@0:     void endProperty(String name);
michael@0: 
michael@0:     /**
michael@0:      * Triggers the handling of a parameter.
michael@0:      * @param name a parameter name
michael@0:      * @param value a parameter value
michael@0:      * @throws URISyntaxException where the parameter value is not a valid URI for applicable parameters
michael@0:      */
michael@0:     void parameter(String name, String value) throws URISyntaxException;
michael@0: }