Java InputStreamReader Read readFile(InputStream aStream)

Description

Reads the contents of the given stream as a String and closes the stream.

License

Open Source License

Parameter

Parameter	Description
aStream	Stream to be read.

Exception

Parameter	Description
IOException	If an I/O error occurs while reading from or while closing the stream.
NullPointerException	If <code>aStream</code> is <code>null</code>.

Return

The text read from the stream.

Declaration

public static final String readFile(InputStream aStream) throws IOException 

Method Source Code

//package com.java2s;
/*//  www.  j a  v  a2  s. co m
 * #%L
 * Cytoscape NetworkAnalyzer Impl (network-analyzer-impl)
 * $Id:$
 * $HeadURL:$
 * %%
 * Copyright (C) 2006 - 2013
 *   Max Planck Institute for Informatics, Saarbruecken, Germany
 *   The Cytoscape Consortium
 * %%
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as 
 * published by the Free Software Foundation, either version 2.1 of the 
 * License, or (at your option) any later version.
 * 
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Lesser Public License for more details.
 * 
 * You should have received a copy of the GNU General Lesser Public 
 * License along with this program.  If not, see
 * <http://www.gnu.org/licenses/lgpl-2.1.html>.
 * #L%
 */

import java.io.BufferedReader;
import java.io.Closeable;
import java.io.IOException;
import java.io.InputStream;
import java.io.InputStreamReader;

public class Main {
    /**
     * Reads the contents of the given stream as a <code>String</code> and closes the stream.
     * 
     * @param aStream
     *            Stream to be read.
     * @return The text read from the stream.
     * 
     * @throws IOException
     *             If an I/O error occurs while reading from or while closing the stream.
     * @throws NullPointerException
     *             If <code>aStream</code> is <code>null</code>.
     */
    public static final String readFile(InputStream aStream) throws IOException {
        final StringBuilder text = new StringBuilder();

        BufferedReader reader = null;
        try {
            reader = new BufferedReader(new InputStreamReader(aStream));
            for (String line = reader.readLine(); line != null; line = reader.readLine()) {
                if (text.length() != 0) {
                    text.append("\n");
                }
                text.append(line);
            }
        } catch (IOException ex) {
            closeStream(reader);
            throw ex;
        }
        reader.close();
        return text.toString();
    }

    /**
     * Silently closes the given stream.
     * <p>
     * This method does not throw an exception in any circumstances.
     * </p>
     * 
     * @param aStream
     *            Stream to be closed.
     */
    public static void closeStream(Closeable aStream) {
        try {
            aStream.close();
        } catch (Exception ex) {
            // Unsuccessful attempt to close the stream; ignore
        }
    }
}

Related

1. readFile(final File inputFile)
2. readFile(final String aFileName)
3. readFile(final String path)
4. readFile(IFile file)
5. readFile(IFile theFile)
6. readFile(InputStream in)
7. readFile(InputStream in)
8. readFile(InputStream inputStream)
9. readFile(InputStream inputStream)