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.io.OutputStream;
michael@0: import java.io.OutputStreamWriter;
michael@0: import java.io.Writer;
michael@0: 
michael@0: import net.fortuna.ical4j.model.Calendar;
michael@0: import net.fortuna.ical4j.model.ValidationException;
michael@0: 
michael@0: /**
michael@0:  * <pre>
michael@0:  * $Id$ [Apr 5, 2004]
michael@0:  * </pre>
michael@0:  *
michael@0:  * Writes an iCalendar model to an output stream.
michael@0:  * @author Ben Fortuna
michael@0:  */
michael@0: public class CalendarOutputter extends AbstractOutputter {
michael@0: 
michael@0:     /**
michael@0:      * Default constructor.
michael@0:      */
michael@0:     public CalendarOutputter() {
michael@0:         super();
michael@0:     }
michael@0: 
michael@0:     /**
michael@0:      * @param validating indicates whether to validate calendar when outputting to stream
michael@0:      */
michael@0:     public CalendarOutputter(final boolean validating) {
michael@0:         super(validating);
michael@0:     }
michael@0: 
michael@0:     /**
michael@0:      * @param validating indicates whether to validate calendar when outputting to stream
michael@0:      * @param foldLength maximum number of characters before a line is folded
michael@0:      */
michael@0:     public CalendarOutputter(final boolean validating, final int foldLength) {
michael@0:         super(validating, foldLength);
michael@0:     }
michael@0: 
michael@0:     /**
michael@0:      * Outputs an iCalender string to the specified output stream.
michael@0:      * @param calendar calendar to write to ouput stream
michael@0:      * @param out an output stream
michael@0:      * @throws IOException thrown when unable to write to output stream
michael@0:      * @throws ValidationException where calendar validation fails
michael@0:      */
michael@0:     public final void output(final Calendar calendar, final OutputStream out)
michael@0:             throws IOException, ValidationException {
michael@0:         output(calendar, new OutputStreamWriter(out, DEFAULT_CHARSET));
michael@0:     }
michael@0: 
michael@0:     /**
michael@0:      * Outputs an iCalender string to the specified writer.
michael@0:      * @param calendar calendar to write to writer
michael@0:      * @param out a writer
michael@0:      * @throws IOException thrown when unable to write to writer
michael@0:      * @throws ValidationException where calendar validation fails
michael@0:      */
michael@0:     public final void output(final Calendar calendar, final Writer out)
michael@0:             throws IOException, ValidationException {
michael@0:         if (isValidating()) {
michael@0:             calendar.validate();
michael@0:         }
michael@0: 
michael@0:         final FoldingWriter writer = new FoldingWriter(out, foldLength);
michael@0:         try {
michael@0:             writer.write(calendar.toString());
michael@0:         }
michael@0:         finally {
michael@0:             writer.close();
michael@0:         }
michael@0:     }
michael@0: }