MxlDynamics.java

package com.xenoage.zong.musicxml.types;

import static com.xenoage.utils.EnumUtils.getEnumValue;
import lombok.AllArgsConstructor;
import lombok.Getter;
import lombok.Setter;

import com.xenoage.utils.annotations.MaybeNull;
import com.xenoage.utils.xml.XmlReader;
import com.xenoage.utils.xml.XmlWriter;
import com.xenoage.zong.core.music.direction.DynamicValue;
import com.xenoage.zong.musicxml.types.attributes.MxlPrintStyle;
import com.xenoage.zong.musicxml.types.choice.MxlDirectionTypeContent;
import com.xenoage.zong.musicxml.types.choice.MxlNotationsContent;
import com.xenoage.zong.musicxml.types.enums.MxlPlacement;
import com.xenoage.zong.musicxml.types.util.MxlPlacementContent;
import com.xenoage.zong.musicxml.types.util.MxlPrintStyleContent;
import com.xenoage.zong.musicxml.util.IncompleteMusicXML;

/**
 * MusicXML dynamics.
 * 
 * Only the first child element is read.
 * Combinations are not allowed here.
 * 
 * @author Andreas Wenger
 */
@IncompleteMusicXML(partly = "")
@AllArgsConstructor @Getter @Setter
public final class MxlDynamics
	implements MxlNotationsContent, MxlDirectionTypeContent, MxlPrintStyleContent, MxlPlacementContent {

	public static final String elemName = "dynamics";

	private DynamicValue element;
	private MxlPrintStyle printStyle;
	private MxlPlacement placement;


	@Override public MxlNotationsContentType getNotationsContentType() {
		return MxlNotationsContentType.Dynamics;
	}

	@Override public MxlDirectionTypeContentType getDirectionTypeContentType() {
		return MxlDirectionTypeContentType.Dynamics;
	}

	/**
	 * Reads the given element and returns it, or returns null if
	 * the element is empty or not supported.
	 */
	@MaybeNull public static MxlDynamics read(XmlReader reader) {
		//attributes
		MxlPrintStyle printStyle = MxlPrintStyle.read(reader);
		MxlPlacement placement = MxlPlacement.read(reader);
		//get first element
		if (false == reader.openNextChildElement())
			return null; //dynamics element may be empty according to schema
		String childText = reader.getElementName();
		reader.closeElement();
		DynamicValue element = getEnumValue(childText, DynamicValue.values());
		if (element != null)
			return new MxlDynamics(element, printStyle, placement);
		else
			return null;
	}

	@Override public void write(XmlWriter writer) {
		writer.writeElementStart(elemName);
		printStyle.write(writer);
		placement.write(writer);
		writer.writeElementEmpty(element.name());
		writer.writeElementEnd();
	}

}