org.tritonus.share.sampled.AudioFormatSet Maven / Gradle / Ivy
/*
* AudioFormatSet.java
*
* This file is part of Tritonus: http://www.tritonus.org/
*/
/*
* Copyright (c) 2000 by Florian Bomers
*
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU Library General Public License as published
* by the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Library General Public License for more details.
*
* You should have received a copy of the GNU Library General Public
* License along with this program; if not, write to the Free Software
* Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
*
*/
/*
|<--- this code is formatted to fit into 80 columns --->|
*/
package org.tritonus.share.sampled;
import java.util.Collection;
import java.util.Iterator;
import javax.sound.sampled.AudioFormat;
import org.tritonus.share.ArraySet;
import org.tritonus.share.sampled.AudioFormats;
/**
* A set where the elements are uniquely referenced by
* AudioFormats.equals rather than their object reference.
* No 2 equal AudioFormats can exist in the set.
*
* This class provide convenience methods like
* getAudioFormat(AudioFormat) and
* matches(AudioFormat).
*
* The contains(Object elem) and get(Object elem)
* fail, if elem is not an instance of AudioFormat.
*
* You shouldn't use the ArrayList specific functions
* like those that take index parameters.
*
* It is not possible to add null elements.
*
* Currently, the methods equals(.,.) and matches(.,.) of
* class AudioFormats are used. Let's hope that they will
* be integrated into AudioFormat.
*/
public class AudioFormatSet extends ArraySet
{
private static final long serialVersionUID = 1;
protected static final AudioFormat[] EMPTY_FORMAT_ARRAY = new AudioFormat[0];
public AudioFormatSet() {
super();
}
public AudioFormatSet(Collection c) {
super(c);
}
@Override
public boolean add(AudioFormat elem) {
if (elem==null) {
return false;
}
return super.add(elem);
}
public boolean contains(AudioFormat elem) {
if (elem==null) {
return false;
}
AudioFormat comp= elem;
Iterator it=iterator();
while (it.hasNext()) {
if (AudioFormats.equals(comp, it.next())) {
return true;
}
}
return false;
}
public AudioFormat get(AudioFormat elem) {
if (elem==null) {
return null;
}
AudioFormat comp= elem;
Iterator it=iterator();
while (it.hasNext()) {
AudioFormat thisElem=it.next();
if (AudioFormats.equals(comp, thisElem)) {
return thisElem;
}
}
return null;
}
public AudioFormat getAudioFormat(AudioFormat elem) {
return get(elem);
}
/**
* Checks whether this Set contains an AudioFormat
* that matches elem.
* The first matching format is returned. If no element
* matches elem, null is returned.
*
* @see AudioFormats#matches(AudioFormat, AudioFormat)
*/
public AudioFormat matches(AudioFormat elem) {
if (elem==null) {
return null;
}
Iterator it=iterator();
while (it.hasNext()) {
AudioFormat thisElem=it.next();
if (AudioFormats.matches(elem, thisElem)) {
return thisElem;
}
}
return null;
}
// $$mp: TODO: remove; should be obsolete
public AudioFormat[] toAudioFormatArray() {
return toArray(EMPTY_FORMAT_ARRAY);
}
@Override
public void add(int index, AudioFormat element) {
throw new UnsupportedOperationException("unsupported");
}
@Override
public AudioFormat set(int index, AudioFormat element) {
throw new UnsupportedOperationException("unsupported");
}
}
/*** AudioFormatSet.java ***/