Home | History | Annotate | Download | only in asset
      1 /*
      2  * Copyright (c) 2009-2010 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.jme3.asset;
     34 
     35 /**
     36  * <code>AssetEventListener</code> is an interface for listening to various
     37  * events happening inside {@link AssetManager}. For now, it is possible
     38  * to receive an event when an asset has been requested
     39  * (one of the AssetManager.load***() methods were called), or when
     40  * an asset has been loaded.
     41  *
     42  * @author Kirill Vainer
     43  */
     44 public interface AssetEventListener {
     45 
     46     /**
     47      * Called when an asset has been successfully loaded (e.g: loaded from
     48      * file system and parsed).
     49      *
     50      * @param key the AssetKey for the asset loaded.
     51      */
     52     public void assetLoaded(AssetKey key);
     53 
     54     /**
     55      * Called when an asset has been requested (e.g any of the load*** methods
     56      * in AssetManager are called).
     57      * In contrast to the assetLoaded() method, this one will be called even
     58      * if the asset has failed to load, or if it was retrieved from the cache.
     59      *
     60      * @param key
     61      */
     62     public void assetRequested(AssetKey key);
     63 
     64     /**
     65      * Called when an asset dependency cannot be found for an asset.
     66      * When an asset is loaded, each of its dependent assets that
     67      * have failed to load due to a {@link AssetNotFoundException}, will cause
     68      * an invocation of this callback.
     69      *
     70      * @param parentKey The key of the parent asset that is being loaded
     71      * from within the user application.
     72      * @param dependentAssetKey The asset key of the dependent asset that has
     73      * failed to load.
     74      */
     75     public void assetDependencyNotFound(AssetKey parentKey, AssetKey dependentAssetKey);
     76 
     77 }
     78