net.raphimc.noteblocklib.model

Class Notes

java.lang.Object

net.raphimc.noteblocklib.model.Notes

public class Notes
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
Notes()

Method Summary

Modifier and Type	Method and Description
void	add(int tick, java.util.List<Note> notes)
void	add(int tick, Note note)
void	clear()
void	clearTick(int tick)
void	compact() Removes empty note lists from the notes map.
Notes	copy()
void	forEach(java.util.function.Consumer<Note> noteConsumer) Applies the given consumer to all notes.
java.util.List<Note>	get(int tick)
int	getLastTick()
int	getLengthInTicks()
int	getNoteCount()
java.util.List<Note>	getOrEmpty(int tick)
java.util.Set<java.lang.Integer>	getTicks()
void	removeDoubleNotes() Removes duplicate notes which are on the same tick.
void	removeIf(java.util.function.Predicate<Note> notePredicate) Removes all notes which match the given predicate.
void	removeSilentNotes() Removes all notes which have a volume of 0.
void	removeSilentNotes(float threshold) Removes all notes which have a volume lower than or equal the given threshold.
void	set(int tick, java.util.List<Note> notes)
boolean	testEach(java.util.function.Predicate<Note> notePredicate) Applies the given predicate to all notes.

Methods inherited from class java.lang.Object

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

Constructor Detail

Notes

public Notes()

Method Detail

get

public java.util.List<Note> get(int tick)

getOrEmpty

public java.util.List<Note> getOrEmpty(int tick)

set

public void set(int tick,
                java.util.List<Note> notes)

add

public void add(int tick,
                Note note)

add

public void add(int tick,
                java.util.List<Note> notes)

getTicks

public java.util.Set<java.lang.Integer> getTicks()

clearTick

public void clearTick(int tick)

clear

public void clear()

forEach

public void forEach(java.util.function.Consumer<Note> noteConsumer)

Applies the given consumer to all notes.
Use cases for this method can be for example to transpose all notes in a song to be within the minecraft octave range.

Parameters:

noteConsumer - The consumer

testEach

public boolean testEach(java.util.function.Predicate<Note> notePredicate)

Applies the given predicate to all notes.
The predicate can return true to break the iteration.
Use cases for this method can be for example to check if any note is outside the minecraft octave range.

Parameters:

notePredicate - The predicate

Returns:

True if the predicate returned true for any note

removeIf

public void removeIf(java.util.function.Predicate<Note> notePredicate)

Removes all notes which match the given predicate.

Parameters:

notePredicate - The predicate

removeDoubleNotes

public void removeDoubleNotes()

Removes duplicate notes which are on the same tick.
Useful when handling large MIDI files with a lot of duplicate notes.

removeSilentNotes

public void removeSilentNotes()

Removes all notes which have a volume of 0.

removeSilentNotes

public void removeSilentNotes(float threshold)

Removes all notes which have a volume lower than or equal the given threshold.

Parameters:

threshold - The threshold (0.0 - 1.0)

compact

public void compact()

Removes empty note lists from the notes map.

getLastTick

public int getLastTick()

Returns:

The last tick in the song.

getLengthInTicks

public int getLengthInTicks()

Returns:

The length of the song in ticks.

getNoteCount

public int getNoteCount()

Returns:

The total amount of notes in a song.

copy

public Notes copy()