View Javadoc
1   // ******************************************************************************
2   //
3   // Title:       Force Field X.
4   // Description: Force Field X - Software for Molecular Biophysics.
5   // Copyright:   Copyright (c) Michael J. Schnieders 2001-2024.
6   //
7   // This file is part of Force Field X.
8   //
9   // Force Field X is free software; you can redistribute it and/or modify it
10  // under the terms of the GNU General Public License version 3 as published by
11  // the Free Software Foundation.
12  //
13  // Force Field X is distributed in the hope that it will be useful, but WITHOUT
14  // ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
15  // FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
16  // details.
17  //
18  // You should have received a copy of the GNU General Public License along with
19  // Force Field X; if not, write to the Free Software Foundation, Inc., 59 Temple
20  // Place, Suite 330, Boston, MA 02111-1307 USA
21  //
22  // Linking this library statically or dynamically with other modules is making a
23  // combined work based on this library. Thus, the terms and conditions of the
24  // GNU General Public License cover the whole combination.
25  //
26  // As a special exception, the copyright holders of this library give you
27  // permission to link this library with independent modules to produce an
28  // executable, regardless of the license terms of these independent modules, and
29  // to copy and distribute the resulting executable under terms of your choice,
30  // provided that you also meet, for each linked independent module, the terms
31  // and conditions of the license of that module. An independent module is a
32  // module which is not derived from or based on this library. If you modify this
33  // library, you may extend this exception to your version of the library, but
34  // you are not obligated to do so. If you do not wish to do so, delete this
35  // exception statement from your version.
36  //
37  // ******************************************************************************
38  package ffx.utilities;
39  
40  import java.io.ByteArrayOutputStream;
41  import java.io.PrintStream;
42  import java.io.UnsupportedEncodingException;
43  import java.nio.charset.Charset;
44  
45  /**
46   * StringOutputStream class.
47   *
48   * @author Michael J. Schnieders
49   * @since 1.0
50   */
51  public class StringOutputStream extends PrintStream {
52  
53    ByteArrayOutputStream byteArrayOutputStream;
54    Charset charset;
55  
56    /**
57     * Constructor for StringOutputStream.
58     *
59     * @param byteArrayOutputStream a {@link java.io.ByteArrayOutputStream} object.
60     * @throws java.io.UnsupportedEncodingException if any.
61     */
62    public StringOutputStream(ByteArrayOutputStream byteArrayOutputStream)
63        throws UnsupportedEncodingException {
64      super(byteArrayOutputStream, true, Charset.defaultCharset().displayName());
65      this.byteArrayOutputStream = byteArrayOutputStream;
66      charset = Charset.defaultCharset();
67    }
68  
69    /**
70     * Constructor for StringOutputStream.
71     *
72     * @param byteArrayOutputStream a {@link java.io.ByteArrayOutputStream} object.
73     * @param charset a {@link java.nio.charset.Charset} object.
74     * @throws java.io.UnsupportedEncodingException if any.
75     */
76    public StringOutputStream(ByteArrayOutputStream byteArrayOutputStream, Charset charset)
77        throws UnsupportedEncodingException {
78      super(byteArrayOutputStream, true, charset.displayName());
79      this.byteArrayOutputStream = byteArrayOutputStream;
80      this.charset = charset;
81    }
82  
83    /**
84     * close.
85     */
86    public void close() {
87      super.close();
88      try {
89        byteArrayOutputStream.close();
90      } catch (Exception e) {
91        //
92      }
93    }
94  
95    /**
96     * toString.
97     *
98     * @return a {@link java.lang.String} object.
99     */
100   public String toString() {
101     return byteArrayOutputStream.toString(charset);
102   }
103 }