org.xmlactions.common.io.ResourceIO.java Source code

Introduction

Here is the source code for org.xmlactions.common.io.ResourceIO.java

Source

/*
 * Copyright (C) Mike Murphy 2003-2015 <mike.murphy@xmlactions.org><mwjmurphy@gmail.com>
 *
 * 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 org.xmlactions.common.io;

import java.io.File;
import java.io.FileInputStream;
import java.io.InputStream;
import java.net.URL;

import org.apache.commons.io.IOUtils;

/**
 * These method are more focused on accessing resource files requiring a CLass<?> parameter.
 * @author mike
 *
 */
public class ResourceIO {

    /**
     * Load a String from a file location or a resource location (path or classpath)
     * @param name - can be fileName or resourceFileName
     * @return the loaded String
     */
    public static String loadFileOrResource(Class<?> clas, String name) {

        String errorMessage = "Unable to load resource from [" + name + "]";
        InputStream inputStream = null;
        try {
            inputStream = openInputStreamForFileOrResource(clas, name);
            String fileContent = IOUtils.toString(inputStream);
            return fileContent;
        } catch (IllegalArgumentException ex) {
            throw ex;
        } catch (Exception ex) {
            throw new IllegalArgumentException(errorMessage, ex);
        } finally {
            IOUtils.closeQuietly(inputStream);
        }
    }

    /**
     * Open InputStream from a file location or a resource location (path or classpath)
     * <p>
     *    <b>You must close the inputstream</b> maybe use <code>IOUtils.closeQuietly(inputStream);</code>
     * </p>
     * @param name - can be fileName or resourceFileName
     * @return the loaded String
     */
    public static InputStream openInputStreamForFileOrResource(Class<?> clas, String name) {

        String errorMessage = "Unable to load resource from [" + name + "]";
        InputStream inputStream = null;
        try {
            if (new File(name).exists() == true) {
                inputStream = new FileInputStream(name);
            } else {
                URL url = clas.getResource(name);
                if (url == null) {
                    throw new IllegalArgumentException(errorMessage);
                }
                inputStream = url.openStream();
            }
            return inputStream;
        } catch (IllegalArgumentException ex) {
            throw ex;
        } catch (Exception ex) {
            throw new IllegalArgumentException(errorMessage, ex);
        }
    }
}