1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000 1.2 +++ b/src/net/fortuna/ical4j/data/CalendarOutputter.java Tue Feb 10 18:12:00 2015 +0100 1.3 @@ -0,0 +1,107 @@ 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.io.OutputStream; 1.39 +import java.io.OutputStreamWriter; 1.40 +import java.io.Writer; 1.41 + 1.42 +import net.fortuna.ical4j.model.Calendar; 1.43 +import net.fortuna.ical4j.model.ValidationException; 1.44 + 1.45 +/** 1.46 + * <pre> 1.47 + * $Id$ [Apr 5, 2004] 1.48 + * </pre> 1.49 + * 1.50 + * Writes an iCalendar model to an output stream. 1.51 + * @author Ben Fortuna 1.52 + */ 1.53 +public class CalendarOutputter extends AbstractOutputter { 1.54 + 1.55 + /** 1.56 + * Default constructor. 1.57 + */ 1.58 + public CalendarOutputter() { 1.59 + super(); 1.60 + } 1.61 + 1.62 + /** 1.63 + * @param validating indicates whether to validate calendar when outputting to stream 1.64 + */ 1.65 + public CalendarOutputter(final boolean validating) { 1.66 + super(validating); 1.67 + } 1.68 + 1.69 + /** 1.70 + * @param validating indicates whether to validate calendar when outputting to stream 1.71 + * @param foldLength maximum number of characters before a line is folded 1.72 + */ 1.73 + public CalendarOutputter(final boolean validating, final int foldLength) { 1.74 + super(validating, foldLength); 1.75 + } 1.76 + 1.77 + /** 1.78 + * Outputs an iCalender string to the specified output stream. 1.79 + * @param calendar calendar to write to ouput stream 1.80 + * @param out an output stream 1.81 + * @throws IOException thrown when unable to write to output stream 1.82 + * @throws ValidationException where calendar validation fails 1.83 + */ 1.84 + public final void output(final Calendar calendar, final OutputStream out) 1.85 + throws IOException, ValidationException { 1.86 + output(calendar, new OutputStreamWriter(out, DEFAULT_CHARSET)); 1.87 + } 1.88 + 1.89 + /** 1.90 + * Outputs an iCalender string to the specified writer. 1.91 + * @param calendar calendar to write to writer 1.92 + * @param out a writer 1.93 + * @throws IOException thrown when unable to write to writer 1.94 + * @throws ValidationException where calendar validation fails 1.95 + */ 1.96 + public final void output(final Calendar calendar, final Writer out) 1.97 + throws IOException, ValidationException { 1.98 + if (isValidating()) { 1.99 + calendar.validate(); 1.100 + } 1.101 + 1.102 + final FoldingWriter writer = new FoldingWriter(out, foldLength); 1.103 + try { 1.104 + writer.write(calendar.toString()); 1.105 + } 1.106 + finally { 1.107 + writer.close(); 1.108 + } 1.109 + } 1.110 +}