package org.apache.torque.generator.configuration.option;

/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */

import java.util.Collection;

import org.apache.torque.generator.configuration.ConfigurationException;
import org.apache.torque.generator.configuration.ConfigurationProvider;
import org.apache.torque.generator.option.Option;

/**
 * The part of the configuration which provides information to set options.
 */
public interface OptionsConfiguration
{
    /**
     * Retrieves the configured options and returns them.
     *
     * @param configurationProvider The configuration provider to access
     *        the option files.
     *
     * @return the read options, not null.
     *
     * @throws ConfigurationException if an error occurs while reading
     *         the options.
     */
    Collection<Option> getOptions(
            ConfigurationProvider configurationProvider)
                    throws ConfigurationException;
}
