MatsimResource.java

Go to the documentation of this file.

/* *********************************************************************** *
 * project: org.matsim.*
 * MatsimResource.java
 *                                                                         *
 * *********************************************************************** *
 *                                                                         *
 * copyright       : (C) 2008 by the members listed in the COPYING,        *
 *                   LICENSE and WARRANTY file.                            *
 * email           : info at matsim dot org                                *
 *                                                                         *
 * *********************************************************************** *
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *   See also COPYING, LICENSE and WARRANTY file                           *
 *                                                                         *
 * *********************************************************************** */

package org.matsim.core.gbl;

import java.awt.Image;
import java.io.File;
import java.io.FileInputStream;
import java.io.FileNotFoundException;
import java.io.IOException;
import java.io.InputStream;
import java.net.MalformedURLException;
import java.net.URL;

import javax.imageio.ImageIO;

import org.apache.logging.log4j.LogManager;
import org.apache.logging.log4j.Logger;

public abstract class MatsimResource {

    private static final String RES_PATH_JARFILE = "/res/";

    private static final String RES_PATH_LOCAL = "./res/";  //NOPMD // this line should be ignored for PMD analysis
    private static final String RES_PATH_LOCAL2 = "./src/main/resources/res/";  //NOPMD // this line should be ignored for PMD analysis

    private static final Logger log = LogManager.getLogger(MatsimResource.class);

    public final static URL getAsURL(final String filename) {
        // look for the file locally
        {
        File file = new File(RES_PATH_LOCAL + filename);
        if (file.exists()) {
            try {
                return file.toURI().toURL();
            } catch (MalformedURLException e) {
                log.warn("Found resource-file, but could not return URL for it.", e);               // just continue, maybe we have more luck in the classpath
            }
        }
        }
        {
        File file = new File(RES_PATH_LOCAL2 + filename);
        if (file.exists()) {
            try {
                return file.toURI().toURL();
            } catch (MalformedURLException e) {
                log.warn("Found resource-file, but could not return URL for it.", e);               // just continue, maybe we have more luck in the classpath
            }
        }
        }
        // maybe we find the file in the classpath, possibly inside a jar-file
        URL url = MatsimResource.class.getResource(RES_PATH_JARFILE + filename);
        if (url == null) {
            log.warn("Resource '" + filename + "' not found!");
        }
        return url;
    }

    public final static InputStream getAsInputStream(final String filename) {
        // look for the file locally
        try {
            return new FileInputStream(RES_PATH_LOCAL + filename);
        } catch (FileNotFoundException e) {
            log.info("Resource '" + filename + "' not found locally. May not be fatal.");
            // just continue, maybe we have more luck in the classpath
        }
        // maybe we find the file in the classpath, possibly inside a jar-file
        InputStream stream = MatsimResource.class.getResourceAsStream(RES_PATH_JARFILE + filename);
        if (stream == null) {
            log.warn("Resource '" + filename + "' not found!");
        }
        return stream;
    }

    public final static Image getAsImage(final String filename) {
        final URL url = getAsURL(filename);
        if (url == null) {
            return null;
        }
        try {
            return ImageIO.read(url);
        } catch (IOException e) {
            log.error("Could not load requested image", e);
            return null;
        }
    }
}