OpenConcerto

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

svn://code.openconcerto.org/openconcerto

Rev

Rev 156 | 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
 
177 ilm 44
    public static final File NULL_FILE = new File(System.getProperty("os.name").startsWith("Windows") ? "NUL" : "/dev/null");
45
 
17 ilm 46
    /**
47
     * Verbatim copy an entry from input to output stream.
48
     *
49
     * @param in the source.
50
     * @param out the destination.
51
     * @throws IOException if an error occurs while reading or writing.
52
     */
53
    public static void copy(InputStream in, OutputStream out) throws IOException {
156 ilm 54
        // TODO use in.transferTo(out) in Java 9
17 ilm 55
        copy(in, out, 512 * 1024);
56
    }
57
 
58
    public static void copy(InputStream in, OutputStream out, final int bufferSize) throws IOException {
67 ilm 59
        copy(in, out, bufferSize, -1);
60
    }
61
 
62
    public static long copy(InputStream in, OutputStream out, final int bufferSize, final long length) throws IOException {
156 ilm 63
        if (bufferSize < 1)
64
            throw new IllegalArgumentException("Buffer size too small : " + bufferSize);
17 ilm 65
        final byte[] buffer = new byte[bufferSize];
67 ilm 66
        long totalCount = 0;
67
        final boolean copyAll = length < 0;
68
        while (copyAll || totalCount < length) {
69
            final long toRead = copyAll ? buffer.length : Math.min(length - totalCount, buffer.length);
70
            // since buffer.length is an int
156 ilm 71
            assert 0 < toRead && toRead <= Integer.MAX_VALUE;
67 ilm 72
            final int count = in.read(buffer, 0, (int) toRead);
156 ilm 73
            if (count <= 0) {
74
                // like Files.copy(InputStream, OutputStream), stop if reading 0 bytes
75
                if (count == 0)
76
                    Log.get().log(Level.WARNING, "", new IllegalStateException("read() returned 0 for " + in));
17 ilm 77
                break;
156 ilm 78
            }
67 ilm 79
            totalCount += count;
17 ilm 80
            out.write(buffer, 0, count);
81
        }
67 ilm 82
        // < if end of stream
83
        assert copyAll || totalCount <= length;
84
        return totalCount;
17 ilm 85
    }
86
 
87
    public static void copy(InputStream ins, File out) throws IOException {
156 ilm 88
        Files.copy(ins, out.toPath(), StandardCopyOption.REPLACE_EXISTING);
17 ilm 89
    }
90
 
94 ilm 91
    /**
92
     * Read until the end of the stream is reached. NOTE : since this method didn't create the
93
     * stream, it doesn't close it.
94
     *
95
     * @param ins the stream to read from.
96
     * @return the bytes.
97
     * @throws IOException if an error occurs.
98
     */
99
    public static byte[] read(final InputStream ins) throws IOException {
100
        final ByteArrayOutputStream out = new ByteArrayOutputStream(512);
101
        copy(ins, out);
102
        return out.toByteArray();
103
    }
104
 
17 ilm 105
    public static void writeln(final String s, final OutputStream out) throws IOException {
106
        write(s + "\n", out);
107
    }
108
 
109
    public static void write(final String s, final OutputStream out) throws IOException {
67 ilm 110
        write(s, out, StringUtils.UTF8);
17 ilm 111
    }
112
 
113
    public static void write(final String s, final OutputStream out, Charset charset) throws IOException {
114
        out.write(s.getBytes(charset));
115
    }
116
 
67 ilm 117
    /**
118
     * Wrap the output stream into a writer, and write the XML declaration.
119
     *
120
     * @param outs an output stream.
121
     * @return a writer with the same encoding as the XML.
122
     * @throws IOException if an error occurs.
123
     */
124
    public static BufferedWriter createXMLWriter(OutputStream outs) throws IOException {
125
        return new BufferedWriter(createXMLUnbufferedWriter(outs));
126
    }
127
 
128
    public static Writer createXMLUnbufferedWriter(OutputStream outs) throws IOException {
129
        // see http://www.w3.org/TR/REC-xml/#sec-guessing
130
        // don't use UTF-8 BOM as Java does not support it :
131
        // http://bugs.sun.com/bugdatabase/view_bug.do?bug_id=4508058
132
        final Writer res = new OutputStreamWriter(outs, StringUtils.UTF8);
133
        res.write("<?xml version='1.0' encoding='UTF-8' ?>\n");
134
        return res;
135
    }
17 ilm 136
}