Rest.java

package com.xenoage.zong.core.music.rest;

import static com.xenoage.utils.CheckUtils.checkArgsNotNull;
import lombok.Getter;
import lombok.Setter;

import com.xenoage.utils.annotations.NonNull;
import com.xenoage.utils.math.Fraction;
import com.xenoage.zong.core.music.MusicElementType;
import com.xenoage.zong.core.music.Voice;
import com.xenoage.zong.core.music.VoiceElement;
import com.xenoage.zong.core.position.MP;


/**
 * Class for a rest.
 *
 * @author Andreas Wenger
 */
public final class Rest
	implements VoiceElement {

	/** The duration of this rest. */
	@Getter @Setter @NonNull private Fraction duration;
	/** True, if this rest has cue size, otherwise false. */
	@Getter @Setter private boolean cue = false;
	/** True, if this rest is not visible (e.g. because it is at the beginning of a second voice). */
	@Getter @Setter private boolean hidden = false;
	
	/** Back reference: the parent voice, or null if not part of a score. */
	@Getter @Setter private Voice parent = null;


	public Rest(Fraction duration) {
		checkArgsNotNull(duration);
		this.duration = duration;
	}

	@Override public String toString() {
		return "rest(dur:" + duration + ")";
	}

	@Override public MusicElementType getMusicElementType() {
		return MusicElementType.Rest;
	}
	
	@Override public MP getMP() {
		return MP.getMPFromParent(this);
	}
	
}