Source for javax.sound.midi.SoundbankResource

   1: /* SoundbankResource.java -- An audio resource from a sound bank
   2:    Copyright (C) 2005 Free Software Foundation, Inc.
   3: 
   4: This file is part of GNU Classpath.
   5: 
   6: GNU Classpath is free software; you can redistribute it and/or modify
   7: it under the terms of the GNU General Public License as published by
   8: the Free Software Foundation; either version 2, or (at your option)
   9: any later version.
  10: 
  11: GNU Classpath is distributed in the hope that it will be useful, but
  12: WITHOUT ANY WARRANTY; without even the implied warranty of
  13: MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14: General Public License for more details.
  15: 
  16: You should have received a copy of the GNU General Public License
  17: along with GNU Classpath; see the file COPYING.  If not, write to the
  18: Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  19: 02110-1301 USA.
  20: 
  21: Linking this library statically or dynamically with other modules is
  22: making a combined work based on this library.  Thus, the terms and
  23: conditions of the GNU General Public License cover the whole
  24: combination.
  25: 
  26: As a special exception, the copyright holders of this library give you
  27: permission to link this library with independent modules to produce an
  28: executable, regardless of the license terms of these independent
  29: modules, and to copy and distribute the resulting executable under
  30: terms of your choice, provided that you also meet, for each linked
  31: independent module, the terms and conditions of the license of that
  32: module.  An independent module is a module which is not derived from
  33: or based on this library.  If you modify this library, you may extend
  34: this exception to your version of the library, but you are not
  35: obligated to do so.  If you do not wish to do so, delete this
  36: exception statement from your version. */
  37: 
  38: 
  39: package javax.sound.midi;
  40: 
  41: /**
  42:  * SoundbankResource objects represent audio data stored in a sound bank.
  43:  * 
  44:  * @author Anthony Green (green@redhat.com)
  45:  * @since 1.3
  46:  *
  47:  */
  48: public abstract class SoundbankResource
  49: {
  50:   private final Soundbank soundbank;
  51:   private final String name;
  52:   private final Class dataClass;
  53:   
  54:   /**
  55:    * Create a SoundbankResource object.
  56:    * 
  57:    * @param soundbank the soundbank object containing this resource
  58:    * @param name the name of the resource
  59:    * @param dataClass the class used to represent the audio data
  60:    */
  61:   protected SoundbankResource(Soundbank soundbank, String name, Class<?> dataClass)
  62:   {
  63:     this.soundbank = soundbank;   
  64:     this.name = name;
  65:     this.dataClass = dataClass;
  66:   }
  67:   
  68:   /**
  69:    * Get the sound bank containing this resource.
  70:    * 
  71:    * @return the sound bank in which this resource resides
  72:    */
  73:   public Soundbank getSoundbank()
  74:   {
  75:     return soundbank;
  76:   }
  77:   
  78:   /**
  79:    * Get the name of this resource.
  80:    * 
  81:    * @return the name of this resource
  82:    */
  83:   public String getName()
  84:   {
  85:     return name;
  86:   }
  87:   
  88:   /**
  89:    * Get the class used to represent the audio data for this resource.
  90:    * 
  91:    * @return the class used to represent the audio data for this resource
  92:    */
  93:   public Class<?> getDataClass()
  94:   {
  95:     return dataClass;
  96:   }
  97:   
  98:   /**
  99:    * Get the audio data for this resource.
 100:    * 
 101:    * @return the audio data object for this resource
 102:    */
 103:   public abstract Object getData();
 104: }