src/share/classes/javax/sound/sampled/AudioFileFormat.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


 234 
 235     /**
 236      * Obtain an unmodifiable map of properties.
 237      * The concept of properties is further explained in
 238      * the {@link AudioFileFormat class description}.
 239      *
 240      * @return a <code>Map&lt;String,Object&gt;</code> object containing
 241      *         all properties. If no properties are recognized, an empty map is
 242      *         returned.
 243      *
 244      * @see #getProperty(String)
 245      * @since 1.5
 246      */
 247     public Map<String,Object> properties() {
 248         Map<String,Object> ret;
 249         if (properties == null) {
 250             ret = new HashMap<String,Object>(0);
 251         } else {
 252             ret = (Map<String,Object>) (properties.clone());
 253         }
 254         return (Map<String,Object>) Collections.unmodifiableMap(ret);
 255     }
 256 
 257 
 258     /**
 259      * Obtain the property value specified by the key.
 260      * The concept of properties is further explained in
 261      * the {@link AudioFileFormat class description}.
 262      *
 263      * <p>If the specified property is not defined for a
 264      * particular file format, this method returns
 265      * <code>null</code>.
 266      *
 267      * @param key the key of the desired property
 268      * @return the value of the property with the specified key,
 269      *         or <code>null</code> if the property does not exist.
 270      *
 271      * @see #properties()
 272      * @since 1.5
 273      */
 274     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


 234 
 235     /**
 236      * Obtain an unmodifiable map of properties.
 237      * The concept of properties is further explained in
 238      * the {@link AudioFileFormat class description}.
 239      *
 240      * @return a <code>Map&lt;String,Object&gt;</code> object containing
 241      *         all properties. If no properties are recognized, an empty map is
 242      *         returned.
 243      *
 244      * @see #getProperty(String)
 245      * @since 1.5
 246      */
 247     public Map<String,Object> properties() {
 248         Map<String,Object> ret;
 249         if (properties == null) {
 250             ret = new HashMap<String,Object>(0);
 251         } else {
 252             ret = (Map<String,Object>) (properties.clone());
 253         }
 254         return Collections.unmodifiableMap(ret);
 255     }
 256 
 257 
 258     /**
 259      * Obtain the property value specified by the key.
 260      * The concept of properties is further explained in
 261      * the {@link AudioFileFormat class description}.
 262      *
 263      * <p>If the specified property is not defined for a
 264      * particular file format, this method returns
 265      * <code>null</code>.
 266      *
 267      * @param key the key of the desired property
 268      * @return the value of the property with the specified key,
 269      *         or <code>null</code> if the property does not exist.
 270      *
 271      * @see #properties()
 272      * @since 1.5
 273      */
 274     public Object getProperty(String key) {