1 /*
   2  * Copyright (c) 2007, 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
  23  * questions.
  24  */
  25 package com.sun.media.sound;
  26 
  27 /**
  28  * Information about property used in  opening {@code AudioSynthesizer}.
  29  *
  30  * @author Karl Helgason
  31  */
  32 public final class AudioSynthesizerPropertyInfo {
  33 
  34     /**
  35      * Constructs an {@code AudioSynthesizerPropertyInfo} object with a given
  36      * name and value. The {@code description} and {@code choices}
  37      * are initialized by {@code null} values.
  38      *
  39      * @param name the name of the property
  40      * @param value the current value or class used for values.
  41      *
  42      */
  43     public AudioSynthesizerPropertyInfo(String name, Object value) {
  44         this.name = name;
  45         if (value instanceof Class)
  46             valueClass = (Class)value;
  47         else
  48         {
  49             this.value = value;
  50             if (value != null)
  51                 valueClass = value.getClass();
  52         }
  53     }
  54     /**
  55      * The name of the property.
  56      */
  57     public String name;
  58     /**
  59      * A brief description of the property, which may be null.
  60      */
  61     public String description = null;
  62     /**
  63      * The {@code value} field specifies the current value of
  64      * the property.
  65      */
  66     public Object value = null;
  67     /**
  68      * The {@code valueClass} field specifies class
  69      * used in {@code value} field.
  70      */
  71     public Class<?> valueClass = null;
  72     /**
  73      * An array of possible values if the value for the field
  74      * {@code AudioSynthesizerPropertyInfo.value} may be selected
  75      * from a particular set of values; otherwise null.
  76      */
  77     public Object[] choices = null;
  78 
  79 }