SoundResourceRequest.java

/**
 * Copyright (c) 2003-2009, Xith3D Project Group all rights reserved.
 * 
 * Portions based on the Java3D interface, Copyright by Sun Microsystems.
 * Many thanks to the developers of Java3D and Sun Microsystems for their
 * innovation and design.
 * 
 * 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 the 'Xith3D Project Group' 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) A
 * RISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE
 */
package org.xith3d.resources;

import java.io.IOException;

import org.xith3d.loaders.sound.ExtensionSoundLoader;
import org.xith3d.loaders.sound.SoundLoader;
import org.xith3d.sound.SoundContainer;

/**
 * This is a ResourceRequest for a Sound resource to be loaded with
 * ExtensionSoundLoader.
 * 
 * @author Marvin Froehlich (aka Qudus)
 */
public class SoundResourceRequest implements ResourceRequest
{
    private final String name;
    private final String bagName;
    private final SoundLoader loader;
    
    /**
     * {@inheritDoc}
     */
    public final String getName()
    {
        return ( name );
    }
    
    /**
     * {@inheritDoc}
     */
    public final String getBagName()
    {
        return ( bagName );
    }
    
    /**
     * @return the TextureStreamLocator used to load this Texture resource (or <i>null</i>)
     */
    public final SoundLoader getSoundLoader()
    {
        return ( loader );
    }
    
    /**
     * {@inheritDoc}
     */
    public Object loadResource( ResourceLocator resLoc, ResourceBag resBag ) throws IOException
    {
        SoundLoader loader = getSoundLoader();
        if ( loader == null )
            loader = ExtensionSoundLoader.getInstance();
        
        SoundContainer sound = loader.loadSound( resLoc.getResource( getName() ) );
        
        resBag.addSound( getBagName(), sound );
        
        return ( sound );
    }
    
    /**
     * Creates a new TextureResourceRequest.
     * 
     * @param name the name of the Texture resource to use for loading
     * @param bagName the name, that the Texture resource will carry in the ResourceBag
     * @param loader the SoundLoader to use for loading this Sound resource
     */
    public SoundResourceRequest( String name, String bagName, SoundLoader loader )
    {
        this.name = name;
        this.bagName = bagName;
        this.loader = loader;
    }
    
    /**
     * Creates a new TextureResourceRequest.
     * 
     * @param name the name of the Texture resource to use for loading
     * @param bagName the name, that the Texture resource will carry in the ResourceBag
     */
    public SoundResourceRequest( String name, String bagName )
    {
        this( name, bagName, (SoundLoader)null );
    }
}