com.jme3.asset.CloneableSmartAsset Maven / Gradle / Ivy
Show all versions of jme3-core Show documentation
/*
* Copyright (c) 2009-2023 jMonkeyEngine
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are
* met:
*
* * Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
*
* * Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* * Neither the name of 'jMonkeyEngine' nor the names of its contributors
* may be used to endorse or promote products derived from this software
* without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
* TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
* PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
* CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
* EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
* PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
* PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
* LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
* NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package com.jme3.asset;
import com.jme3.asset.cache.WeakRefCloneAssetCache;
/**
* Implementing the CloneableSmartAsset interface allows use
* of cloneable smart asset management.
*
* Smart asset management requires cooperation from the {@link AssetKey}.
* In particular, the AssetKey should return {@link WeakRefCloneAssetCache} in its
* {@link AssetKey#getCacheType()} method. Also smart assets MUST
* create a clone of the asset and cannot return the same reference,
* e.g. {@link AssetProcessor#createClone(java.lang.Object) createClone(someAsset)} != someAsset.
*
* If the {@link AssetManager#loadAsset(com.jme3.asset.AssetKey) } method
* is called twice with the same asset key (equals() wise, not necessarily reference wise)
* then both assets will have the same asset key set (reference wise) via
* {@link AssetKey#AssetKey() }, then this asset key
* is used to track all instances of that asset. Once all clones of the asset
* are garbage collected, the shared asset key becomes unreachable and at that
* point it is removed from the smart asset cache.
*/
public interface CloneableSmartAsset extends Cloneable {
/**
* Creates a clone of the asset.
*
* Please see {@link Object#clone() } for more info on how this method
* should be implemented.
*
* @return A clone of this asset.
* The cloned asset cannot reference equal this asset.
*/
public CloneableSmartAsset clone();
/**
* Assigns the specified AssetKey to the asset.
*
* This is invoked by the {@link AssetManager}.
* Only clones of the asset have non-null keys. The original copy that
* was loaded has no key assigned. Only the clones are tracked
* for garbage collection.
*
* @param key The AssetKey to assign
*/
public void setKey(AssetKey key);
/**
* Returns the asset key that is used to track this asset for garbage
* collection.
*
* @return the asset key that is used to track this asset for garbage
* collection.
*/
public AssetKey getKey();
}