src/share/classes/javax/sound/midi/MidiFileFormat.java

Print this page


   1 /*
   2  * Copyright (c) 1999, 2007, Oracle and/or its affiliates. All rights reserved.
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * This code is free software; you can redistribute it and/or modify it
   6  * under the terms of the GNU General Public License version 2 only, as
   7  * published by the Free Software Foundation.  Oracle designates this
   8  * particular file as subject to the "Classpath" exception as provided
   9  * by Oracle in the LICENSE file that accompanied this code.
  10  *
  11  * This code is distributed in the hope that it will be useful, but WITHOUT
  12  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  13  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  14  * version 2 for more details (a copy is included in the LICENSE file that
  15  * accompanied this code).
  16  *
  17  * You should have received a copy of the GNU General Public License version
  18  * 2 along with this work; if not, write to the Free Software Foundation,
  19  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  20  *
  21  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
  22  * or visit www.oracle.com if you need additional information or have any


  33 
  34 
  35 /**
  36  * A <code>MidiFileFormat</code> object encapsulates a MIDI file's
  37  * type, as well as its length and timing information.
  38  *
  39  * <p>A <code>MidiFileFormat</code> object can
  40  * include a set of properties. A property is a pair of key and value:
  41  * the key is of type <code>String</code>, the associated property
  42  * value is an arbitrary object.
  43  * Properties specify additional informational
  44  * meta data (like a author, or copyright).
  45  * Properties are optional information, and file reader and file
  46  * writer implementations are not required to provide or
  47  * recognize properties.
  48  *
  49  * <p>The following table lists some common properties that should
  50  * be used in implementations:
  51  *
  52  * <table border=1>

  53  *  <tr>
  54  *   <th>Property key</th>
  55  *   <th>Value type</th>
  56  *   <th>Description</th>
  57  *  </tr>
  58  *  <tr>
  59  *   <td>&quot;author&quot;</td>
  60  *   <td>{@link java.lang.String String}</td>
  61  *   <td>name of the author of this file</td>
  62  *  </tr>
  63  *  <tr>
  64  *   <td>&quot;title&quot;</td>
  65  *   <td>{@link java.lang.String String}</td>
  66  *   <td>title of this file</td>
  67  *  </tr>
  68  *  <tr>
  69  *   <td>&quot;copyright&quot;</td>
  70  *   <td>{@link java.lang.String String}</td>
  71  *   <td>copyright message</td>
  72  *  </tr>


   1 /*
   2  * Copyright (c) 1999, 2013, Oracle and/or its affiliates. All rights reserved.
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * This code is free software; you can redistribute it and/or modify it
   6  * under the terms of the GNU General Public License version 2 only, as
   7  * published by the Free Software Foundation.  Oracle designates this
   8  * particular file as subject to the "Classpath" exception as provided
   9  * by Oracle in the LICENSE file that accompanied this code.
  10  *
  11  * This code is distributed in the hope that it will be useful, but WITHOUT
  12  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  13  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  14  * version 2 for more details (a copy is included in the LICENSE file that
  15  * accompanied this code).
  16  *
  17  * You should have received a copy of the GNU General Public License version
  18  * 2 along with this work; if not, write to the Free Software Foundation,
  19  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  20  *
  21  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
  22  * or visit www.oracle.com if you need additional information or have any


  33 
  34 
  35 /**
  36  * A <code>MidiFileFormat</code> object encapsulates a MIDI file's
  37  * type, as well as its length and timing information.
  38  *
  39  * <p>A <code>MidiFileFormat</code> object can
  40  * include a set of properties. A property is a pair of key and value:
  41  * the key is of type <code>String</code>, the associated property
  42  * value is an arbitrary object.
  43  * Properties specify additional informational
  44  * meta data (like a author, or copyright).
  45  * Properties are optional information, and file reader and file
  46  * writer implementations are not required to provide or
  47  * recognize properties.
  48  *
  49  * <p>The following table lists some common properties that should
  50  * be used in implementations:
  51  *
  52  * <table border=1>
  53     <caption>MIDI File Format Properties</caption>
  54  *  <tr>
  55  *   <th>Property key</th>
  56  *   <th>Value type</th>
  57  *   <th>Description</th>
  58  *  </tr>
  59  *  <tr>
  60  *   <td>&quot;author&quot;</td>
  61  *   <td>{@link java.lang.String String}</td>
  62  *   <td>name of the author of this file</td>
  63  *  </tr>
  64  *  <tr>
  65  *   <td>&quot;title&quot;</td>
  66  *   <td>{@link java.lang.String String}</td>
  67  *   <td>title of this file</td>
  68  *  </tr>
  69  *  <tr>
  70  *   <td>&quot;copyright&quot;</td>
  71  *   <td>{@link java.lang.String String}</td>
  72  *   <td>copyright message</td>
  73  *  </tr>