com.admc.util.IOUtil Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2011 Axis Data Management Corp.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */


package com.admc.util;

import java.io.File;
import java.io.FileInputStream;
import java.io.InputStream;
import java.io.InputStreamReader;
import java.io.IOException;
import java.io.BufferedReader;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;

/**
 * There is much functional overlap between this class and Apache Commons IO.
 * This class is distinctive because it has methods that efficiently generate
 * StringBuilders.
 * It also uses UTF-8 encoding.  It neither honors the environment encoding
 * default not allows for configuring an alternative.
 *
 * @author Blaine Simpson (blaine dot simpson at admc dot com)
 * @since 1.1.2
 */
public class IOUtil {
    private static Log log = LogFactory.getLog(IOUtil.class);

    /**
     * This class provides only static methods.  Do not instantiate.
     */
    private IOUtil() { }

    public static String toString(File file) throws IOException {
        return IOUtil.toString(new FileInputStream(file), 10240);
    }

    public static StringBuilder toStringBuilder(File file) throws IOException {
        return IOUtil.toStringBuilder(new FileInputStream(file), 10240);
    }

    /**
     * Wrapper for toString(InputStream, int) with buffer size of
     * 10240 characters.
     *
     * @see #toString(InputStream, int)
     */
    public static String toString(InputStream inputStream) throws IOException {
        return IOUtil.toString(inputStream, 10240);
    }

    /**
     * Generates a String from specified InputStream, using UTF-8 encoding.
     */
    public static String toString(
            InputStream inputStream, int bufferChars) throws IOException {
        return IOUtil.toStringBuilder(inputStream, bufferChars).toString();
    }

    /**
     * Wrapper for toStringBuilder(InputStream, int) with buffer size of
     * 10240 characters.
     *
     * @see #toStringBuilder(InputStream, int)
     */
    public static StringBuilder toStringBuilder(InputStream inputStream)
            throws IOException {
        return IOUtil.toStringBuilder(inputStream, 10240);
    }

    /**
     * Generates a StringBuilder from specified InputStream,
     * using UTF-8 encoding.
     *
     * If the input stream can be initialized by this method, then this method
     * will also close it.
     */
    public static StringBuilder toStringBuilder(
            InputStream inputStream, int bufferChars) throws IOException {
        char[] buffer = new char[bufferChars];
        int i;
        StringBuilder sb = new StringBuilder();
        BufferedReader reader = new BufferedReader(
                new InputStreamReader(inputStream, "UTF-8"));
        try {
            while ((i = reader.read(buffer)) > -1) sb.append(buffer, 0, i);
        } finally {
            try {
                reader.close();
            } catch (IOException ioe) {
                log.error("Failed to close reader", ioe);
            }
            reader = null;
        }
        return sb;
    }
}