OpenConcerto

Dépôt officiel du code source de l'ERP OpenConcerto
sonarqube

svn://code.openconcerto.org/openconcerto

Rev

Rev 94 | Details | Compare with Previous | Last modification | View Log | RSS feed

Rev Author Line No. Line
17 ilm 1
/*
2
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
3
 *
4
 * Copyright 2011 OpenConcerto, by ILM Informatique. All rights reserved.
5
 *
6
 * The contents of this file are subject to the terms of the GNU General Public License Version 3
7
 * only ("GPL"). You may not use this file except in compliance with the License. You can obtain a
8
 * copy of the License at http://www.gnu.org/licenses/gpl-3.0.html See the License for the specific
9
 * language governing permissions and limitations under the License.
10
 *
11
 * When distributing the software, include this License Header Notice in each file.
12
 */
13
 
14
 package org.openconcerto.utils;
15
 
67 ilm 16
import java.io.BufferedWriter;
94 ilm 17
import java.io.ByteArrayOutputStream;
17 ilm 18
import java.io.File;
19
import java.io.IOException;
20
import java.io.InputStream;
21
import java.io.OutputStream;
67 ilm 22
import java.io.OutputStreamWriter;
23
import java.io.Writer;
17 ilm 24
import java.nio.charset.Charset;
156 ilm 25
import java.nio.file.Files;
26
import java.nio.file.StandardCopyOption;
27
import java.util.logging.Level;
17 ilm 28
 
29
public class StreamUtils {
30
 
31
    public static final OutputStream NULL_OS = new OutputStream() {
32
        @Override
33
        public void write(int b) throws IOException {
34
            // ignore
35
        }
36
 
37
        public void write(byte b[], int off, int len) throws IOException {
38
            if (b == null)
39
                throw new NullPointerException();
40
            // ignore
41
        }
42
    };
43
 
44
    /**
45
     * Verbatim copy an entry from input to output stream.
46
     *
47
     * @param in the source.
48
     * @param out the destination.
49
     * @throws IOException if an error occurs while reading or writing.
50
     */
51
    public static void copy(InputStream in, OutputStream out) throws IOException {
156 ilm 52
        // TODO use in.transferTo(out) in Java 9
17 ilm 53
        copy(in, out, 512 * 1024);
54
    }
55
 
56
    public static void copy(InputStream in, OutputStream out, final int bufferSize) throws IOException {
67 ilm 57
        copy(in, out, bufferSize, -1);
58
    }
59
 
60
    public static long copy(InputStream in, OutputStream out, final int bufferSize, final long length) throws IOException {
156 ilm 61
        if (bufferSize < 1)
62
            throw new IllegalArgumentException("Buffer size too small : " + bufferSize);
17 ilm 63
        final byte[] buffer = new byte[bufferSize];
67 ilm 64
        long totalCount = 0;
65
        final boolean copyAll = length < 0;
66
        while (copyAll || totalCount < length) {
67
            final long toRead = copyAll ? buffer.length : Math.min(length - totalCount, buffer.length);
68
            // since buffer.length is an int
156 ilm 69
            assert 0 < toRead && toRead <= Integer.MAX_VALUE;
67 ilm 70
            final int count = in.read(buffer, 0, (int) toRead);
156 ilm 71
            if (count <= 0) {
72
                // like Files.copy(InputStream, OutputStream), stop if reading 0 bytes
73
                if (count == 0)
74
                    Log.get().log(Level.WARNING, "", new IllegalStateException("read() returned 0 for " + in));
17 ilm 75
                break;
156 ilm 76
            }
67 ilm 77
            totalCount += count;
17 ilm 78
            out.write(buffer, 0, count);
79
        }
67 ilm 80
        // < if end of stream
81
        assert copyAll || totalCount <= length;
82
        return totalCount;
17 ilm 83
    }
84
 
85
    public static void copy(InputStream ins, File out) throws IOException {
156 ilm 86
        Files.copy(ins, out.toPath(), StandardCopyOption.REPLACE_EXISTING);
17 ilm 87
    }
88
 
94 ilm 89
    /**
90
     * Read until the end of the stream is reached. NOTE : since this method didn't create the
91
     * stream, it doesn't close it.
92
     *
93
     * @param ins the stream to read from.
94
     * @return the bytes.
95
     * @throws IOException if an error occurs.
96
     */
97
    public static byte[] read(final InputStream ins) throws IOException {
98
        final ByteArrayOutputStream out = new ByteArrayOutputStream(512);
99
        copy(ins, out);
100
        return out.toByteArray();
101
    }
102
 
17 ilm 103
    public static void writeln(final String s, final OutputStream out) throws IOException {
104
        write(s + "\n", out);
105
    }
106
 
107
    public static void write(final String s, final OutputStream out) throws IOException {
67 ilm 108
        write(s, out, StringUtils.UTF8);
17 ilm 109
    }
110
 
111
    public static void write(final String s, final OutputStream out, Charset charset) throws IOException {
112
        out.write(s.getBytes(charset));
113
    }
114
 
67 ilm 115
    /**
116
     * Wrap the output stream into a writer, and write the XML declaration.
117
     *
118
     * @param outs an output stream.
119
     * @return a writer with the same encoding as the XML.
120
     * @throws IOException if an error occurs.
121
     */
122
    public static BufferedWriter createXMLWriter(OutputStream outs) throws IOException {
123
        return new BufferedWriter(createXMLUnbufferedWriter(outs));
124
    }
125
 
126
    public static Writer createXMLUnbufferedWriter(OutputStream outs) throws IOException {
127
        // see http://www.w3.org/TR/REC-xml/#sec-guessing
128
        // don't use UTF-8 BOM as Java does not support it :
129
        // http://bugs.sun.com/bugdatabase/view_bug.do?bug_id=4508058
130
        final Writer res = new OutputStreamWriter(outs, StringUtils.UTF8);
131
        res.write("<?xml version='1.0' encoding='UTF-8' ?>\n");
132
        return res;
133
    }
17 ilm 134
}