src/com/jme/util/resource/ResourceLocatorTool.java

   1 /*
   2  * Copyright (c) 2003-2009 jMonkeyEngine
   3  * All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions are
   7  * met:
   8  *
   9  * * Redistributions of source code must retain the above copyright
  10  *   notice, this list of conditions and the following disclaimer.
  11  *
  12  * * Redistributions in binary form must reproduce the above copyright
  13  *   notice, this list of conditions and the following disclaimer in the
  14  *   documentation and/or other materials provided with the distribution.
  15  *
  16  * * Neither the name of 'jMonkeyEngine' nor the names of its contributors
  17  *   may be used to endorse or promote products derived from this software
  18  *   without specific prior written permission.
  19  *
  20  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  21  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
  22  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  23  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
  24  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
  25  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
  26  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
  27  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
  28  * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
  29  * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
  30  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  31  */
  32
  33 package com.jme.util.resource;
  34
  35 import java.net.URL;
  36 import java.util.ArrayList;
  37 import java.util.HashMap;
  38 import java.util.Map;
  39 import java.util.logging.Level;
  40 import java.util.logging.Logger;
  41
  42 /**
  43  * Manager class for locator utility classes used to find various assets. (XXX: Needs more documentation)
  44  *
  45  * @author Joshua Slack
  46  */
  47
  48 public class ResourceLocatorTool {
  49     private static final Logger logger = Logger.getLogger(ResourceLocatorTool.class
  50             .getName());
  51
  52     public static final String TYPE_TEXTURE = "texture";
  53     public static final String TYPE_MODEL = "model";
  54     public static final String TYPE_PARTICLE = "particle";
  55     public static final String TYPE_AUDIO = "audio";
  56     public static final String TYPE_SHADER = "shader";
  57
  58     private static final Map<String, ArrayList<ResourceLocator>> locatorMap = new HashMap<String, ArrayList<ResourceLocator>>();
  59
  60     public static URL locateResource(String resourceType, String resourceName) {
  61         if (resourceName == null) {
  62             return null;
  63         }
  64         synchronized (locatorMap) {
  65             ArrayList<ResourceLocator> bases = locatorMap.get(resourceType);
  66             if (bases != null) {
  67                 for (int i = bases.size(); --i >= 0; ) {
  68                     ResourceLocator loc = bases.get(i);
  69                     URL rVal = loc.locateResource(resourceName);
  70                     if (rVal != null) {
  71                         return rVal;
  72                     }
  73                 }
  74             }
  75             // last resort...
  76             try {
  77                 URL u = ResourceLocatorTool.class.getResource(resourceName);
  78                 if (u != null) {
  79                     return u;
  80                 }
  81             } catch (Exception e) {
  82                 logger.logp(Level.WARNING, ResourceLocatorTool.class.getName(),
  83                         "locateResource(String, String)", e.getMessage(), e);
  84             }
  85
  86             logger.warning("Unable to locate: "+resourceName);
  87             return null;
  88         }
  89     }
  90
  91     public static void addResourceLocator(String resourceType,
  92             ResourceLocator locator) {
  93         if (locator == null) return;
  94         synchronized (locatorMap) {
  95             ArrayList<ResourceLocator> bases = locatorMap.get(resourceType);
  96             if (bases == null) {
  97                 bases = new ArrayList<ResourceLocator>();
  98                 locatorMap.put(resourceType, bases);
  99             }
 100
 101             if (!bases.contains(locator)) {
 102                 bases.add(locator);
 103             }
 104         }
 105     }
 106
 107     public static boolean removeResourceLocator(String resourceType,
 108             ResourceLocator locator) {
 109         synchronized (locatorMap) {
 110             ArrayList<ResourceLocator> bases = locatorMap.get(resourceType);
 111             if (bases == null) {
 112                 return false;
 113             }
 114             return bases.remove(locator);
 115         }
 116     }
 117 }