src/share/classes/javax/sound/sampled/AudioFormat.java

Print this page


   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


 386 
 387     /**
 388      * Obtain an unmodifiable map of properties.
 389      * The concept of properties is further explained in
 390      * the {@link AudioFileFormat class description}.
 391      *
 392      * @return a <code>Map&lt;String,Object&gt;</code> object containing
 393      *         all properties. If no properties are recognized, an empty map is
 394      *         returned.
 395      *
 396      * @see #getProperty(String)
 397      * @since 1.5
 398      */
 399     public Map<String,Object> properties() {
 400         Map<String,Object> ret;
 401         if (properties == null) {
 402             ret = new HashMap<String,Object>(0);
 403         } else {
 404             ret = (Map<String,Object>) (properties.clone());
 405         }
 406         return (Map<String,Object>) Collections.unmodifiableMap(ret);
 407     }
 408 
 409 
 410     /**
 411      * Obtain the property value specified by the key.
 412      * The concept of properties is further explained in
 413      * the {@link AudioFileFormat class description}.
 414      *
 415      * <p>If the specified property is not defined for a
 416      * particular file format, this method returns
 417      * <code>null</code>.
 418      *
 419      * @param key the key of the desired property
 420      * @return the value of the property with the specified key,
 421      *         or <code>null</code> if the property does not exist.
 422      *
 423      * @see #properties()
 424      * @since 1.5
 425      */
 426     public Object getProperty(String key) {


   1 /*
   2  * Copyright (c) 1999, 2014, 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


 386 
 387     /**
 388      * Obtain an unmodifiable map of properties.
 389      * The concept of properties is further explained in
 390      * the {@link AudioFileFormat class description}.
 391      *
 392      * @return a <code>Map&lt;String,Object&gt;</code> object containing
 393      *         all properties. If no properties are recognized, an empty map is
 394      *         returned.
 395      *
 396      * @see #getProperty(String)
 397      * @since 1.5
 398      */
 399     public Map<String,Object> properties() {
 400         Map<String,Object> ret;
 401         if (properties == null) {
 402             ret = new HashMap<String,Object>(0);
 403         } else {
 404             ret = (Map<String,Object>) (properties.clone());
 405         }
 406         return Collections.unmodifiableMap(ret);
 407     }
 408 
 409 
 410     /**
 411      * Obtain the property value specified by the key.
 412      * The concept of properties is further explained in
 413      * the {@link AudioFileFormat class description}.
 414      *
 415      * <p>If the specified property is not defined for a
 416      * particular file format, this method returns
 417      * <code>null</code>.
 418      *
 419      * @param key the key of the desired property
 420      * @return the value of the property with the specified key,
 421      *         or <code>null</code> if the property does not exist.
 422      *
 423      * @see #properties()
 424      * @since 1.5
 425      */
 426     public Object getProperty(String key) {