View Javadoc
1   /*
2    * Copyright (C) 2012, Robin Rosenberg <robin.rosenberg@dewire.com>
3    * and other copyright owners as documented in the project's IP log.
4    *
5    * This program and the accompanying materials are made available
6    * under the terms of the Eclipse Distribution License v1.0 which
7    * accompanies this distribution, is reproduced below, and is
8    * available at http://www.eclipse.org/org/documents/edl-v10.php
9    *
10   * All rights reserved.
11   *
12   * Redistribution and use in source and binary forms, with or
13   * without modification, are permitted provided that the following
14   * conditions are met:
15   *
16   * - Redistributions of source code must retain the above copyright
17   *   notice, this list of conditions and the following disclaimer.
18   *
19   * - Redistributions in binary form must reproduce the above
20   *   copyright notice, this list of conditions and the following
21   *   disclaimer in the documentation and/or other materials provided
22   *   with the distribution.
23   *
24   * - Neither the name of the Eclipse Foundation, Inc. nor the
25   *   names of its contributors may be used to endorse or promote
26   *   products derived from this software without specific prior
27   *   written permission.
28   *
29   * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
30   * CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
31   * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
32   * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
33   * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
34   * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
35   * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
36   * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
37   * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
38   * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
39   * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
40   * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
41   * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
42   */
43  package org.eclipse.jgit.util.io;
44  
45  import java.io.IOException;
46  import java.io.Writer;
47  import java.security.AccessController;
48  import java.security.PrivilegedAction;
49  
50  import org.eclipse.jgit.util.SystemReader;
51  
52  /**
53   * An alternative PrintWriter that doesn't catch exceptions.
54   *
55   * @since 2.2
56   */
57  public class ThrowingPrintWriter extends Writer {
58  
59  	private final Writer out;
60  
61  	private final String LF;
62  
63  	/**
64  	 * Construct a JGitPrintWriter
65  	 *
66  	 * @param out
67  	 *            the underlying {@link java.io.Writer}
68  	 */
69  	public ThrowingPrintWriter(Writer out) {
70  		this.out = out;
71  		LF = AccessController.doPrivileged(new PrivilegedAction<String>() {
72  			@Override
73  			public String run() {
74  				return SystemReader.getInstance().getProperty("line.separator"); //$NON-NLS-1$
75  			}
76  		});
77  	}
78  
79  	/** {@inheritDoc} */
80  	@Override
81  	public void write(char[] cbuf, int off, int len) throws IOException {
82  		out.write(cbuf, off, len);
83  	}
84  
85  	/** {@inheritDoc} */
86  	@Override
87  	public void flush() throws IOException {
88  		out.flush();
89  	}
90  
91  	/** {@inheritDoc} */
92  	@Override
93  	public void close() throws IOException {
94  		out.close();
95  	}
96  
97  	/**
98  	 * Print a string and terminate with a line feed.
99  	 *
100 	 * @param s a {@link java.lang.String} object.
101 	 * @throws java.io.IOException
102 	 */
103 	public void println(String s) throws IOException {
104 		print(s + LF);
105 	}
106 
107 	/**
108 	 * Print a platform dependent new line
109 	 *
110 	 * @throws java.io.IOException
111 	 */
112 	public void println() throws IOException {
113 		print(LF);
114 	}
115 
116 	/**
117 	 * Print a char
118 	 *
119 	 * @param value a char.
120 	 * @throws java.io.IOException
121 	 */
122 	public void print(char value) throws IOException {
123 		print(String.valueOf(value));
124 	}
125 
126 	/**
127 	 * Print an int as string
128 	 *
129 	 * @param value
130 	 *            an int.
131 	 * @throws java.io.IOException
132 	 */
133 	public void print(int value) throws IOException {
134 		print(String.valueOf(value));
135 	}
136 
137 	/**
138 	 * Print a long as string
139 	 *
140 	 * @param value a long.
141 	 * @throws java.io.IOException
142 	 */
143 	public void print(long value) throws IOException {
144 		print(String.valueOf(value));
145 	}
146 
147 	/**
148 	 * Print a short as string
149 	 *
150 	 * @param value a short.
151 	 * @throws java.io.IOException
152 	 */
153 	public void print(short value) throws IOException {
154 		print(String.valueOf(value));
155 	}
156 
157 	/**
158 	 * Print a formatted message according to
159 	 * {@link java.lang.String#format(String, Object...)}.
160 	 *
161 	 * @param fmt
162 	 *            a {@link java.lang.String} object.
163 	 * @param args
164 	 *            objects.
165 	 * @throws java.io.IOException
166 	 */
167 	public void format(String fmt, Object... args) throws IOException {
168 		print(String.format(fmt, args));
169 	}
170 
171 	/**
172 	 * Print an object's toString representations
173 	 *
174 	 * @param any
175 	 *            an object.
176 	 * @throws java.io.IOException
177 	 */
178 	public void print(Object any) throws IOException {
179 		out.write(String.valueOf(any));
180 	}
181 }