|
1 /** |
|
2 * Copyright (c) 2012, Ben Fortuna |
|
3 * All rights reserved. |
|
4 * |
|
5 * Redistribution and use in source and binary forms, with or without |
|
6 * modification, are permitted provided that the following conditions |
|
7 * are met: |
|
8 * |
|
9 * o Redistributions of source code must retain the above copyright |
|
10 * notice, this list of conditions and the following disclaimer. |
|
11 * |
|
12 * o Redistributions in binary form must reproduce the above copyright |
|
13 * notice, this list of conditions and the following disclaimer in the |
|
14 * documentation and/or other materials provided with the distribution. |
|
15 * |
|
16 * o Neither the name of Ben Fortuna nor the names of any other contributors |
|
17 * may be used to endorse or promote products derived from this software |
|
18 * without specific prior written permission. |
|
19 * |
|
20 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS |
|
21 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT |
|
22 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR |
|
23 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR |
|
24 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, |
|
25 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, |
|
26 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR |
|
27 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF |
|
28 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING |
|
29 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS |
|
30 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
|
31 */ |
|
32 package net.fortuna.ical4j.data; |
|
33 |
|
34 import java.io.IOException; |
|
35 import java.io.OutputStream; |
|
36 import java.io.OutputStreamWriter; |
|
37 import java.io.Writer; |
|
38 |
|
39 import net.fortuna.ical4j.model.Calendar; |
|
40 import net.fortuna.ical4j.model.ValidationException; |
|
41 |
|
42 /** |
|
43 * <pre> |
|
44 * $Id$ [Apr 5, 2004] |
|
45 * </pre> |
|
46 * |
|
47 * Writes an iCalendar model to an output stream. |
|
48 * @author Ben Fortuna |
|
49 */ |
|
50 public class CalendarOutputter extends AbstractOutputter { |
|
51 |
|
52 /** |
|
53 * Default constructor. |
|
54 */ |
|
55 public CalendarOutputter() { |
|
56 super(); |
|
57 } |
|
58 |
|
59 /** |
|
60 * @param validating indicates whether to validate calendar when outputting to stream |
|
61 */ |
|
62 public CalendarOutputter(final boolean validating) { |
|
63 super(validating); |
|
64 } |
|
65 |
|
66 /** |
|
67 * @param validating indicates whether to validate calendar when outputting to stream |
|
68 * @param foldLength maximum number of characters before a line is folded |
|
69 */ |
|
70 public CalendarOutputter(final boolean validating, final int foldLength) { |
|
71 super(validating, foldLength); |
|
72 } |
|
73 |
|
74 /** |
|
75 * Outputs an iCalender string to the specified output stream. |
|
76 * @param calendar calendar to write to ouput stream |
|
77 * @param out an output stream |
|
78 * @throws IOException thrown when unable to write to output stream |
|
79 * @throws ValidationException where calendar validation fails |
|
80 */ |
|
81 public final void output(final Calendar calendar, final OutputStream out) |
|
82 throws IOException, ValidationException { |
|
83 output(calendar, new OutputStreamWriter(out, DEFAULT_CHARSET)); |
|
84 } |
|
85 |
|
86 /** |
|
87 * Outputs an iCalender string to the specified writer. |
|
88 * @param calendar calendar to write to writer |
|
89 * @param out a writer |
|
90 * @throws IOException thrown when unable to write to writer |
|
91 * @throws ValidationException where calendar validation fails |
|
92 */ |
|
93 public final void output(final Calendar calendar, final Writer out) |
|
94 throws IOException, ValidationException { |
|
95 if (isValidating()) { |
|
96 calendar.validate(); |
|
97 } |
|
98 |
|
99 final FoldingWriter writer = new FoldingWriter(out, foldLength); |
|
100 try { |
|
101 writer.write(calendar.toString()); |
|
102 } |
|
103 finally { |
|
104 writer.close(); |
|
105 } |
|
106 } |
|
107 } |