RienaConfiguration.java

/*******************************************************************************
 * Copyright (c) 2007, 2014 compeople AG and others.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors:
 *    compeople AG - initial API and implementation
 *******************************************************************************/
package org.eclipse.riena.core.util;

import org.eclipse.riena.core.singleton.SingletonProvider;
import org.eclipse.riena.core.wire.InjectExtension;

/**
 * This class facilitates the access to Riena configuration extensions. See extension point <tt>org.eclipse.riena.core.configuration</tt>.
 * 
 * @since 5.0
 */
public final class RienaConfiguration {

	/**
	 * Controls whether the text ridget writes its value to the model on ENTER key events in multiline text fields.
	 * <p>
	 * The configuration for this property must be set to the extension point <tt>org.eclipse.riena.core.configuration</tt>
	 * <p>
	 * The default for this property (if not set) is <code>false</code>.
	 * 
	 * @since 6.0
	 */
	public static final String MULTILINE_TEXT_IGNORE_ENTER_KEY = "riena.ITextRidget.multilineIgnoreEnterKey"; //$NON-NLS-1$

	/**
	 * Key for the property which controls if ridget marker messages automatically are displayed in the status line.
	 * <p>
	 * The configuration for this property must be set to the extension point <tt>org.eclipse.riena.core.configuration</tt>
	 * <p>
	 * The default for this property (if not set) is <code>false</code>.
	 */
	public static final String SHOW_RIDGET_MESSAGES_IN_STATUSLINE_KEY = "riena.showRidgetMessagesInStatusline"; //$NON-NLS-1$
	/**
	 * Key for the maximum number of sub-module views that will be stocked.
	 * <p>
	 * The configuration for this property must be set to the extension point <tt>org.eclipse.riena.core.configuration</tt>
	 * <p>
	 * The default for this property (if not set) is <code>0</code>. <code>0</code> means a indefinitely number of views are in the stock.
	 */
	public static final String MAX_STOCKED_VIEWS_KEY = "riena.maxStockedViews"; //$NON-NLS-1$

	private final static SingletonProvider<RienaConfiguration> IS = new SingletonProvider<RienaConfiguration>(RienaConfiguration.class);
	private IConfigurationExtension[] extensions;

	private RienaConfiguration() {
		// utility class
	}

	/**
	 * Returns an instance (always the same) of this class.
	 * 
	 * @return instance of {@code RienaConfiguration}
	 */
	public static RienaConfiguration getInstance() {
		return IS.getInstance();
	}

	/**
	 * Retrieves the configured value for the given key. If there are several definitions (several extensions to <tt>org.eclipse.riena.core.configuration</tt>)
	 * with this key it is not defines which of them will be evaluated. This method returns <code>null</code> if there is no definition with the given key.
	 * 
	 * @param key
	 *            the property key
	 * @return the property value or <code>null</code> if a property with that key is not defined
	 */
	public String getProperty(final String key) {
		if (extensions == null) {
			return null;
		}
		for (final IConfigurationExtension e : extensions) {
			if (e.getKey().equals(key)) {
				return e.getValue();
			}
		}
		return null;
	}

	@InjectExtension
	public void update(final IConfigurationExtension[] extensions) {
		this.extensions = extensions;
	}
}