ConfigOptionProvider.java

/**
 * Copyright (c) 2014-2017 by the respective copyright holders.
 * 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
 */
package org.eclipse.smarthome.config.core;

import java.net.URI;
import java.util.Collection;
import java.util.Locale;

/**
 * The {@link ConfigOptionProvider} can be implemented and registered as an <i>OSGi</i>
 * service to provide {@link ConfigDescription}s options.
 *
 * @author Chris Jackson - Initial contribution
 */
public interface ConfigOptionProvider {

    /**
     * Provides a collection of {@link ParameterOptions}s.
     *
     * @param uri
     *            the uri of the config description
     * @param param
     *            the parameter name for which the requested options shall be returned
     * @param locale
     *            locale
     * @return the configuration options provided by this provider (not
     *         null, could be empty)
     */
    Collection<ParameterOption> getParameterOptions(URI uri, String param, Locale locale);
}