com.neocotic.blingaer.common.IOUtils.java Source code

Introduction

Here is the source code for com.neocotic.blingaer.common.IOUtils.java

Source

/* Copyright (C) 2011 Alasdair Mercer, http://neocotic.com/
 * 
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 * 
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 * 
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */
package com.neocotic.blingaer.common;

import java.io.BufferedReader;
import java.io.IOException;
import java.io.Reader;
import java.util.ArrayList;
import java.util.List;

import org.apache.commons.lang3.StringUtils;

/**
 * Provides utility methods for simplifying basic I/O functionality.
 * 
 * @author Alasdair Mercer
 */
// TODO: Test code
public class IOUtils {

    /**
     * Unconditionally closes an the {@code Reader} provided.
     * <p>
     * Does nothing if {@code input} is {@code null} or already closed and
     * ignores any {@code Exceptions} that may be thrown while closing.
     * 
     * @param input
     *            the {@code Reader} to close
     * @see Reader#close()
     */
    public static void closeQuietly(Reader input) {
        if (input != null) {
            try {
                input.close();
            } catch (Exception e) {
                // Ignorance is bliss
            }
        }
    }

    /**
     * Gets the contents of the {@code Reader} provided as a {@code List} of
     * {@code Strings} for each line.
     * 
     * @param input
     *            the {@code Reader} to be read
     * @return a {@code List} of {@code Strings} representing each line
     * @throws IOException
     *             If an I/O error occurs.
     * @throws NullPointerException
     *             If {@code input} is {@code null}.
     */
    public static List<String> readLines(Reader input) throws IOException {
        List<String> list = new ArrayList<String>();
        BufferedReader reader = new BufferedReader(input);

        String line = reader.readLine();

        while (line != null) {
            list.add(line);
            line = reader.readLine();
        }

        return list;
    }

    /**
     * Gets the contents of the {@code Reader} provided as a {@code String}.
     * 
     * @param input
     *            the {@code Reader} to be read
     * @return the {@code String} contents of the {@code Reader}
     * @throws IOException
     *             If an I/O error occurs.
     * @throws NullPointerException
     *             If {@code input} is {@code null}.
     */
    public static String toString(Reader input) throws IOException {
        return StringUtils.join(readLines(input), StringUtils.EMPTY);
    }
}