com.soundhelix.misc

Class Arrangement

java.lang.Object

com.soundhelix.misc.Arrangement

All Implemented Interfaces:

Iterable<Arrangement.ArrangementEntry>

public class Arrangement
extends Object
implements Iterable<Arrangement.ArrangementEntry>

Represents an arrangement. An arrangement consists of pairs of Tracks and instruments.

Author:

Thomas Schuerger (thomas@schuerger.com)

See Also:

Track

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Arrangement.ArrangementEntry Immutable container for an arrangement entry.

Constructor Summary

Constructors

Constructor and Description
Arrangement() Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
void	add(Track track, String instrument) Adds the given track and assigns the given instrument to the track.
Arrangement.ArrangementEntry	get(int index) Returns the arrangement entry with the given index.
Arrangement.ArrangementEntry	get(String instrument) Returns the arrangement entry whose instrument has the given name.
Iterator<Arrangement.ArrangementEntry>	iterator() Provides an iterator that iterates over all ArrangementEntries of this Arrangement in the order the corresponding (Track, Instrument) pairs have been added.
static Arrangement	loadArrangement(String filename) Loads a gzip-serialized arrangement from the given file and returns it.
static void	saveArrangement(Arrangement arrangement, String filename) Serializes this arrangement and writes it in gziped format to the given file.
int	size() Returns the number of arrangement entries.

Methods inherited from class java.lang.Object

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

Constructor Detail

Arrangement

public Arrangement()

Constructor.

Method Detail

add

public void add(Track track,
       String instrument)

Adds the given track and assigns the given instrument to the track.

Parameters:

track - the track

instrument - the instrument

iterator

public Iterator<Arrangement.ArrangementEntry> iterator()

Provides an iterator that iterates over all ArrangementEntries of this Arrangement in the order the corresponding (Track, Instrument) pairs have been added.

Specified by:

iterator in interface Iterable<Arrangement.ArrangementEntry>

Returns:

the iterator

size

public int size()

Returns the number of arrangement entries.

Returns:

the number of entries

get

public Arrangement.ArrangementEntry get(int index)

Returns the arrangement entry with the given index.

Parameters:

index - the index (starting with 0)

Returns:

the arrangement entry

get

public Arrangement.ArrangementEntry get(String instrument)

Returns the arrangement entry whose instrument has the given name. If such an entry doesn't exist, null is returned.

Parameters:

instrument - the name of the instrument

Returns:

the arrangement entry or null

loadArrangement

public static Arrangement loadArrangement(String filename)
                                   throws IOException,
                                          ClassNotFoundException

Loads a gzip-serialized arrangement from the given file and returns it.

Parameters:

filename - the filename of the arrangement to load

Returns:

the read arrangement

Throws:

IOException - in case of an I/O problem

ClassNotFoundException - in case of a deserialization problem

saveArrangement

public static void saveArrangement(Arrangement arrangement,
                   String filename)
                            throws IOException

Serializes this arrangement and writes it in gziped format to the given file.

Parameters:

arrangement - the arrangement to save

filename - the filename to save the arrangement to

Throws:

IOException - in case of an I/O problem