de.cismet.commons.gui.equalizer

Class DefaultEqualizerModel

java.lang.Object

de.cismet.commons.gui.equalizer.AbstractEqualizerModel

de.cismet.commons.gui.equalizer.DefaultEqualizerModel

All Implemented Interfaces:

EqualizerModel

Direct Known Subclasses:

RubberBandEqualizerModel

public class DefaultEqualizerModel
extends AbstractEqualizerModel

This is the default implementation of the EqualizerModel. It ensures that the initial values of the categories are within the Range and that there are no duplicate category names.

Version:

1.0

Author:

martin.scholl@cismet.de

Field Summary

Fields

Modifier and Type	Field and Description
static Range	DEFAULT_RANGE The default range of this model: [0, 100]
protected List<EqualizerCategory>	equalizerCategories

Constructor Summary

Constructors

Constructor and Description
DefaultEqualizerModel(Collection<EqualizerCategory> equalizerCategories) Creates a new DefaultEqualizerModel object using the given list of EqualizerCategorys.
DefaultEqualizerModel(Collection<EqualizerCategory> equalizerCategories, Range range) Creates a new DefaultEqualizerModel object using the given list of EqualizerCategorys and the given Range.

Method Summary

Modifier and Type	Method and Description
void	checkValueWithinRange(int value) Checks if value is within the range of the model.
List<EqualizerCategory>	getEqualizerCategories() Getter for the EqualizerCategorys of this model.
String	getEqualizerCategory(int index) Getter for the category name at the specified index.
int	getEqualizerCategoryCount() Getter for the total amount of available categories.
Range	getRange() Getter for the range this equalizer model covers (boundaries included).
int	getValueAt(int index) Getter for the current value at the specified index.
void	setValueAt(int index, int value) Setter for the a new value at the specified index.

Methods inherited from class de.cismet.commons.gui.equalizer.AbstractEqualizerModel

addEqualizerModelListener, fireEqualizerModelEvent, removeEqualizerModelListener

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DEFAULT_RANGE

public static final Range DEFAULT_RANGE

The default range of this model: [0, 100]

equalizerCategories

protected final List<EqualizerCategory> equalizerCategories

Constructor Detail

DefaultEqualizerModel

public DefaultEqualizerModel(Collection<EqualizerCategory> equalizerCategories)

Creates a new DefaultEqualizerModel object using the given list of EqualizerCategorys. Simply delegates to DefaultEqualizerModel(java.util.Collection, de.cismet.commons.gui.equalizer.Range) using the DEFAULT_RANGE.

Parameters:

equalizerCategories - the EqualizerCategorys of this model

See Also:

DefaultEqualizerModel(java.util.Collection, de.cismet.commons.gui.equalizer.Range)

DefaultEqualizerModel

public DefaultEqualizerModel(Collection<EqualizerCategory> equalizerCategories,
                             Range range)

Creates a new DefaultEqualizerModel object using the given list of EqualizerCategorys and the given Range. null is not permitted for any parameter value and results in an IllegalArgumentException. Additionally, IllegalArgumentException will also be thrown if the category collection is empty or if any of the initial values of the categories is not within Range or there are duplicate category names.

NOTE: The element sorting of the collection's Iterator is responsible for the indexing of available categories. This means that the first element of the Iterator will be available at index 0 while the last element returned by the Iterator will be available at index collection.size() - 1.

Parameters:

equalizerCategories - the EqualizerCategorys of this model

range - the Range of the values of this model's categories

Throws:

IllegalArgumentException - if any argument is null, if the category collection is empty, if there are duplicate category names or if any initial value is not within Range

Method Detail

checkValueWithinRange

public void checkValueWithinRange(int value)

Checks if value is within the range of the model.

Parameters:

value - value to check

Throws:

IllegalArgumentException - if value is not within range of the model

getEqualizerCategories

public List<EqualizerCategory> getEqualizerCategories()

Getter for the EqualizerCategorys of this model. Returns a deep clone of the categories and not the internal collection itself.

Returns:

the categories of this model

getRange

public Range getRange()

Description copied from interface: EqualizerModel

Getter for the range this equalizer model covers (boundaries included). Shall never change.

Returns:

the immutable Range this model covers

getEqualizerCategory

public String getEqualizerCategory(int index)

Description copied from interface: EqualizerModel

Getter for the category name at the specified index. Shall throw IndexOutOfBoundsException if index is < 0 or >= EqualizerModel.getEqualizerCategoryCount().

Parameters:

index - the category index

Returns:

the name of the category at the specified index

getEqualizerCategoryCount

public int getEqualizerCategoryCount()

Description copied from interface: EqualizerModel

Getter for the total amount of available categories.

Returns:

the total amount of available categories

getValueAt

public int getValueAt(int index)

Description copied from interface: EqualizerModel

Getter for the current value at the specified index. Shall throw IndexOutOfBoundsException if index is < 0 or >= EqualizerModel.getEqualizerCategoryCount().

Parameters:

index - the category index

Returns:

the current value at the specified index

setValueAt

public void setValueAt(int index,
                       int value)

Description copied from interface: EqualizerModel

Setter for the a new value at the specified index. The value has to be within the Range of this model. Otherwise an IllegalArgumentException shall be thrown. Shall throw IndexOutOfBoundsException if index is < 0 or >= EqualizerModel.getEqualizerCategoryCount().

Parameters:

index - the category index

value - the new value