org.abego.commons.io.ResourceUtil Maven / Gradle / Ivy

Go to download
/*
 * MIT License
 *
 * Copyright (c) 2020 Udo Borkowski, ([email protected])
 *
 * 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 org.abego.commons.io;

import org.abego.commons.lang.exception.MustNotInstantiateException;

import java.nio.charset.Charset;
import java.nio.charset.StandardCharsets;

import static org.abego.commons.io.InputStreamUtil.textOf;
import static org.abego.commons.lang.ClassUtil.resourceAsStream;
import static org.abego.commons.lang.exception.UncheckedException.newUncheckedException;

public final class ResourceUtil {

    ResourceUtil() {
        throw new MustNotInstantiateException();
    }


    /**
     * Return the text of the resource resourceName of
     * theClass, assuming the text is encoded with the {@link Charset}
     * charset.
     */
    public static String textOfResource(
            Class theClass, String resourceName, Charset charset) {
        try {
            return textOf(resourceAsStream(theClass, resourceName), charset);
        } catch (Exception e) {
            throw newUncheckedException(String.format(
                    "Error when accessing resource `%s` of class `%s`.", // NON-NLS
                    resourceName, theClass.getName()), e);
        }
    }

    /**
     * Return the text of the resource resourceName of
     * theClass, assuming the text is UTF-8 encoded.
     */
    public static String textOfResource(Class theClass, String resourceName) {
        return textOfResource(theClass, resourceName, StandardCharsets.UTF_8);
    }

    /**
     * Return true when a resource with the given name exists in
     * the current CLASSPATH, false otherwise.
     *
     * The CLASSPATH is defined by Thread.currentThread().getContextClassLoader().
     */
    public static boolean hasResource(String name) {
        ClassLoader cl = Thread.currentThread().getContextClassLoader();
        return cl.getResource(name) != null;
    }


}