uk.co.dolphin_com.sscore.playdata

Class BarIterator

java.lang.Object

uk.co.dolphin_com.sscore.playdata.BarIterator

All Implemented Interfaces:

java.util.Iterator<BarIterator.Bar>

public class BarIterator
extends java.lang.Object
implements java.util.Iterator<BarIterator.Bar>

Iterator type which iterates through the score returning each Bar in correct play sequence accounting for repeats

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	BarIterator.Bar Bar returns each Part in the score and also an artificial metronome part which returns a dummy note for each beat in the bar accounting for time signature and tempo changes
class	BarIterator.Part Part returns a NoteIterator for a single Bar

Method Summary

Methods

Modifier and Type	Method and Description
boolean	changeToBar(int barIndex) change to the given bar index.
boolean	countIn()
int	currentBarIndex()
boolean	hasLast()
boolean	hasNext()
BarIterator.Bar	last()
BarIterator.Bar	next()
int	nextBarIndex()
void	remove() unsupported for immutable list
int	sequenceIndex()

Methods inherited from class java.lang.Object

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

Method Detail

hasNext

public boolean hasNext()

Specified by:

hasNext in interface java.util.Iterator<BarIterator.Bar>

Returns:

true if this is not the last bar in the score

next

public BarIterator.Bar next()

Specified by:

next in interface java.util.Iterator<BarIterator.Bar>

Returns:

the next Bar in the score and update this iterator

hasLast

public boolean hasLast()

Returns:

false if this is the first bar in the score (ATTN count-in!)

last

public BarIterator.Bar last()

Returns:

the previous bar in the score and update this iterator

countIn

public boolean countIn()

Returns:

true if this is a count-in bar (ie before the first bar)

sequenceIndex

public int sequenceIndex()

Returns:

the index of this bar in the entire sequence of bars including repeats

currentBarIndex

public int currentBarIndex()

Returns:

the index of this bar in the score (0 is the first bar)

nextBarIndex

public int nextBarIndex()

Returns:

the index of the next bar in the score

changeToBar

public boolean changeToBar(int barIndex)

change to the given bar index. If there is ambiguity because of a repeat it will use the closest occurrence from the current point in the sequence

Parameters:

barIndex - the index of the bar to move to (0 is the first bar in the score)

Returns:

false if it failed because the bar index was not found

remove

public void remove()

unsupported for immutable list

Specified by:

remove in interface java.util.Iterator<BarIterator.Bar>