1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000 1.2 +++ b/src/net/fortuna/ical4j/data/ContentHandler.java Tue Feb 10 18:12:00 2015 +0100 1.3 @@ -0,0 +1,101 @@ 1.4 +/** 1.5 + * Copyright (c) 2012, Ben Fortuna 1.6 + * All rights reserved. 1.7 + * 1.8 + * Redistribution and use in source and binary forms, with or without 1.9 + * modification, are permitted provided that the following conditions 1.10 + * are met: 1.11 + * 1.12 + * o Redistributions of source code must retain the above copyright 1.13 + * notice, this list of conditions and the following disclaimer. 1.14 + * 1.15 + * o Redistributions in binary form must reproduce the above copyright 1.16 + * notice, this list of conditions and the following disclaimer in the 1.17 + * documentation and/or other materials provided with the distribution. 1.18 + * 1.19 + * o Neither the name of Ben Fortuna nor the names of any other contributors 1.20 + * may be used to endorse or promote products derived from this software 1.21 + * without specific prior written permission. 1.22 + * 1.23 + * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 1.24 + * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 1.25 + * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 1.26 + * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR 1.27 + * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, 1.28 + * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, 1.29 + * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR 1.30 + * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF 1.31 + * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING 1.32 + * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS 1.33 + * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 1.34 + */ 1.35 +package net.fortuna.ical4j.data; 1.36 + 1.37 +import java.io.IOException; 1.38 +import java.net.URISyntaxException; 1.39 +import java.text.ParseException; 1.40 + 1.41 +/** 1.42 + * <pre> 1.43 + * $Id$ [Nov 5, 1.44 + * 2004] 1.45 + * </pre> 1.46 + * 1.47 + * Implementors provide functionality applicable during the parsing of an iCalendar data stream (e.g. building an object 1.48 + * model). 1.49 + * @author Ben Fortuna 1.50 + */ 1.51 +public interface ContentHandler { 1.52 + 1.53 + /** 1.54 + * Triggers the start of handling a calendar. 1.55 + */ 1.56 + void startCalendar(); 1.57 + 1.58 + /** 1.59 + * Triggers the end of handling a calendar. 1.60 + */ 1.61 + void endCalendar(); 1.62 + 1.63 + /** 1.64 + * Triggers the start of handling a component. 1.65 + * @param name a component name 1.66 + */ 1.67 + void startComponent(String name); 1.68 + 1.69 + /** 1.70 + * Triggers the end of handling a component. 1.71 + * @param name a component name 1.72 + */ 1.73 + void endComponent(String name); 1.74 + 1.75 + /** 1.76 + * Triggers the start of handling a property. 1.77 + * @param name a property name 1.78 + */ 1.79 + void startProperty(String name); 1.80 + 1.81 + /** 1.82 + * Triggers the handling of a property value. 1.83 + * @param value a property value 1.84 + * @throws URISyntaxException where the property value is not a valid URI for applicable properties 1.85 + * @throws ParseException where the date value cannot be parsed for applicable properties 1.86 + * @throws IOException where data cannot be read for applicable properties 1.87 + */ 1.88 + void propertyValue(String value) throws URISyntaxException, ParseException, 1.89 + IOException; 1.90 + 1.91 + /** 1.92 + * Triggers the end of handling a property. 1.93 + * @param name a property name 1.94 + */ 1.95 + void endProperty(String name); 1.96 + 1.97 + /** 1.98 + * Triggers the handling of a parameter. 1.99 + * @param name a parameter name 1.100 + * @param value a parameter value 1.101 + * @throws URISyntaxException where the parameter value is not a valid URI for applicable parameters 1.102 + */ 1.103 + void parameter(String name, String value) throws URISyntaxException; 1.104 +}