001/* SoundbankResource.java -- An audio resource from a sound bank
002   Copyright (C) 2005 Free Software Foundation, Inc.
003
004This file is part of GNU Classpath.
005
006GNU Classpath is free software; you can redistribute it and/or modify
007it under the terms of the GNU General Public License as published by
008the Free Software Foundation; either version 2, or (at your option)
009any later version.
010
011GNU Classpath is distributed in the hope that it will be useful, but
012WITHOUT ANY WARRANTY; without even the implied warranty of
013MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
014General Public License for more details.
015
016You should have received a copy of the GNU General Public License
017along with GNU Classpath; see the file COPYING.  If not, write to the
018Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
01902110-1301 USA.
020
021Linking this library statically or dynamically with other modules is
022making a combined work based on this library.  Thus, the terms and
023conditions of the GNU General Public License cover the whole
024combination.
025
026As a special exception, the copyright holders of this library give you
027permission to link this library with independent modules to produce an
028executable, regardless of the license terms of these independent
029modules, and to copy and distribute the resulting executable under
030terms of your choice, provided that you also meet, for each linked
031independent module, the terms and conditions of the license of that
032module.  An independent module is a module which is not derived from
033or based on this library.  If you modify this library, you may extend
034this exception to your version of the library, but you are not
035obligated to do so.  If you do not wish to do so, delete this
036exception statement from your version. */
037
038
039package javax.sound.midi;
040
041/**
042 * SoundbankResource objects represent audio data stored in a sound bank.
043 *
044 * @author Anthony Green (green@redhat.com)
045 * @since 1.3
046 *
047 */
048public abstract class SoundbankResource
049{
050  private final Soundbank soundbank;
051  private final String name;
052  private final Class dataClass;
053
054  /**
055   * Create a SoundbankResource object.
056   *
057   * @param soundbank the soundbank object containing this resource
058   * @param name the name of the resource
059   * @param dataClass the class used to represent the audio data
060   */
061  protected SoundbankResource(Soundbank soundbank, String name, Class<?> dataClass)
062  {
063    this.soundbank = soundbank;
064    this.name = name;
065    this.dataClass = dataClass;
066  }
067
068  /**
069   * Get the sound bank containing this resource.
070   *
071   * @return the sound bank in which this resource resides
072   */
073  public Soundbank getSoundbank()
074  {
075    return soundbank;
076  }
077
078  /**
079   * Get the name of this resource.
080   *
081   * @return the name of this resource
082   */
083  public String getName()
084  {
085    return name;
086  }
087
088  /**
089   * Get the class used to represent the audio data for this resource.
090   *
091   * @return the class used to represent the audio data for this resource
092   */
093  public Class<?> getDataClass()
094  {
095    return dataClass;
096  }
097
098  /**
099   * Get the audio data for this resource.
100   *
101   * @return the audio data object for this resource
102   */
103  public abstract Object getData();
104}