1 /* 2 * Copyright (C) 2009-2010, Google Inc. 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 44 package org.eclipse.jgit.util.io; 45 46 import static java.nio.charset.StandardCharsets.UTF_8; 47 48 import java.io.ByteArrayOutputStream; 49 import java.io.IOException; 50 import java.io.OutputStream; 51 import java.io.OutputStreamWriter; 52 import java.io.Writer; 53 54 import org.eclipse.jgit.util.RawParseUtils; 55 56 /** 57 * Combines messages from an OutputStream (hopefully in UTF-8) and a Writer. 58 * <p> 59 * This class is primarily meant for {@code BaseConnection} in contexts where a 60 * standard error stream from a command execution, as well as messages from a 61 * side-band channel, need to be combined together into a buffer to represent 62 * the complete set of messages from a remote repository. 63 * <p> 64 * Writes made to the writer are re-encoded as UTF-8 and interleaved into the 65 * buffer that {@link #getRawStream()} also writes to. 66 * <p> 67 * {@link #toString()} returns all written data, after converting it to a String 68 * under the assumption of UTF-8 encoding. 69 * <p> 70 * Internally {@link org.eclipse.jgit.util.RawParseUtils#decode(byte[])} is used 71 * by {@code toString()} tries to work out a reasonably correct character set 72 * for the raw data. 73 */ 74 public class MessageWriter extends Writer { 75 private final ByteArrayOutputStream buf; 76 77 private final OutputStreamWriter enc; 78 79 /** 80 * Create an empty writer. 81 */ 82 public MessageWriter() { 83 buf = new ByteArrayOutputStream(); 84 enc = new OutputStreamWriter(getRawStream(), UTF_8); 85 } 86 87 /** {@inheritDoc} */ 88 @Override 89 public void write(char[] cbuf, int off, int len) throws IOException { 90 synchronized (buf) { 91 enc.write(cbuf, off, len); 92 enc.flush(); 93 } 94 } 95 96 /** 97 * Get the underlying byte stream that character writes to this writer drop 98 * into. 99 * 100 * @return the underlying byte stream that character writes to this writer 101 * drop into. Writes to this stream should should be in UTF-8. 102 */ 103 public OutputStream getRawStream() { 104 return buf; 105 } 106 107 /** {@inheritDoc} */ 108 @Override 109 public void close() throws IOException { 110 // Do nothing, we are buffered with no resources. 111 } 112 113 /** {@inheritDoc} */ 114 @Override 115 public void flush() throws IOException { 116 // Do nothing, we are buffered with no resources. 117 } 118 119 /** @return string version of all buffered data. */ 120 /** {@inheritDoc} */ 121 @Override 122 public String toString() { 123 return RawParseUtils.decode(buf.toByteArray()); 124 } 125 }