de.espirit.firstspirit.access.editor.ToggleEditorValueExample


package de.espirit.firstspirit.access.editor;

import de.espirit.firstspirit.access.Language;
import de.espirit.firstspirit.access.editor.value.InvalidValueException;

/**
 * Example how to get the value of a ToggleEditValue and how to store a value into a ToggleEditorValue.
 *
 * @since 4.2.34
 */
public class ToggleEditorValueExample {

	/**
	 * Stores the value into the ToggleEditorValue for the given language.
	 *
	 * @since 4.2.34
	 */
	public void setValueForLanguage(final ToggleEditorValue editor, final Boolean value, final Language language) throws InvalidValueException {

		// 1. check if language is provided if editor is language dependent ("useLanguages='yes'" in gom syntax)
		if (editor.isLanguageDependent() && (language == null)) {
			throw new NullPointerException("Language is missing!");
		}

		// 2. store value in the editor value
		editor.set(language, value);
	}


	/**
	 * Returns the value of the ToggleEditorValue for the given language.
	 *
	 * @since 4.2.34
	 */
	public Boolean getValueForLanguage(final ToggleEditorValue editor, final Language language) {

		// 1. get the stored instance in the editor value
		final Boolean value = editor.get(language);

		// 2. and return the value for further processing
		return value;
	}
}