Override Object.toString() to get a reasonable String representation.
[Sone.git] / src / main / java / net / pterodactylus / sone / text / PartContainer.java
1 /*
2  * Sone - PartContainer.java - Copyright © 2010 David Roden
3  *
4  * This program is free software: you can redistribute it and/or modify
5  * it under the terms of the GNU General Public License as published by
6  * the Free Software Foundation, either version 3 of the License, or
7  * (at your option) any later version.
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
16  */
17
18 package net.pterodactylus.sone.text;
19
20 import java.io.IOException;
21 import java.io.StringWriter;
22 import java.io.Writer;
23 import java.util.ArrayList;
24 import java.util.List;
25
26 /**
27  * Part implementation that can contain an arbitrary amount of other parts.
28  * Parts are added using the {@link #add(Part)} method and will be rendered in
29  * the order they are added.
30  *
31  * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
32  */
33 public class PartContainer implements Part {
34
35         /** The parts to render. */
36         private final List<Part> parts = new ArrayList<Part>();
37
38         //
39         // ACCESSORS
40         //
41
42         /**
43          * Adds a part to render.
44          *
45          * @param part
46          *            The part to add
47          */
48         public void add(Part part) {
49                 parts.add(part);
50         }
51
52         //
53         // PART METHODS
54         //
55
56         /**
57          * {@inheritDoc}
58          */
59         @Override
60         public void render(Writer writer) throws IOException {
61                 for (Part part : parts) {
62                         part.render(writer);
63                 }
64         }
65
66         //
67         // OBJECT METHODS
68         //
69
70         @Override
71         public String toString() {
72                 StringWriter stringWriter = new StringWriter();
73                 try {
74                         render(stringWriter);
75                 } catch (IOException ioe1) {
76                         /* should never throw, ignore. */
77                 }
78                 return stringWriter.toString();
79         }
80
81 }