upstream version 1.2.2
[debian/freetts] / com / sun / speech / freetts / PhoneDurations.java
1 /**
2  * Portions Copyright 2001 Sun Microsystems, Inc.
3  * Portions Copyright 1999-2001 Language Technologies Institute, 
4  * Carnegie Mellon University.
5  * All Rights Reserved.  Use is subject to license terms.
6  * 
7  * See the file "license.terms" for information on usage and
8  * redistribution of this file, and for a DISCLAIMER OF ALL 
9  * WARRANTIES.
10  */
11 package com.sun.speech.freetts;
12
13 /**
14  * Maintains a set of <code>PhoneDuration</code> instances indexed by
15  * phone.
16  *
17  * @see PhoneDuration
18  */
19 public interface PhoneDurations {
20     /**
21      * Gets the <code>PhoneDuration</code> for the given phone.  If no
22      * duration is applicable, returns <code>null</code>.  Note that
23      * 'applicable' implementation dependent; some implementations
24      * may return a default value.
25      *
26      * @param phone the phone to get duration information for
27      *
28      * @return the duration information for the phone
29      */
30     public PhoneDuration getPhoneDuration(String phone);
31 }