blob: 96208dab3f6313e4a560da05655a36a828febafd [file] [log] [blame]
J. Duke319a3b92007-12-01 00:00:00 +00001/*
2 * Copyright 2002-2007 Sun Microsystems, Inc. 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. Sun designates this
8 * particular file as subject to the "Classpath" exception as provided
9 * by Sun 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 Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
22 * CA 95054 USA or visit www.sun.com if you need additional information or
23 * have any questions.
24 */
25
26package com.sun.media.sound;
27
28import javax.sound.sampled.Clip;
29
30/**
31 * Interface for Clip objects that close themselves automatically
32 *
33 * @author Florian Bomers
34 */
35interface AutoClosingClip extends Clip {
36
37 /**
38 * Indicates whether this clip instance is auto closing.
39 * When the clip is auto closing, it calls the close()
40 * method automatically after a short period of inactivity.<br>
41 * <br>
42 *
43 * @return true if this clip is auto closing
44 */
45 boolean isAutoClosing();
46
47 /**
48 * Sets whether this Clip instance is auto closing or not.
49 * If true, the close() method will be called automatically
50 * after a short period of inactivity.
51 *
52 * @param value - true to set this clip to auto closing
53 */
54 void setAutoClosing(boolean value);
55}