001package org.apache.maven.settings;
002
003/*
004 * Licensed to the Apache Software Foundation (ASF) under one
005 * or more contributor license agreements.  See the NOTICE file
006 * distributed with this work for additional information
007 * regarding copyright ownership.  The ASF licenses this file
008 * to you under the Apache License, Version 2.0 (the
009 * "License"); you may not use this file except in compliance
010 * with the License.  You may obtain a copy of the License at
011 *
012 *  http://www.apache.org/licenses/LICENSE-2.0
013 *
014 * Unless required by applicable law or agreed to in writing,
015 * software distributed under the License is distributed on an
016 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
017 * KIND, either express or implied.  See the License for the
018 * specific language governing permissions and limitations
019 * under the License.
020 */
021
022import java.io.File;
023import java.io.IOException;
024
025import org.apache.maven.execution.MavenExecutionRequest;
026import org.codehaus.plexus.util.xml.pull.XmlPullParserException;
027
028/**
029 * @author jdcasey
030 * @author Jason van Zyl
031 */
032@Deprecated
033public interface MavenSettingsBuilder
034{
035
036    String ROLE = MavenSettingsBuilder.class.getName();
037
038    String ALT_USER_SETTINGS_XML_LOCATION = "org.apache.maven.user-settings";
039    String ALT_GLOBAL_SETTINGS_XML_LOCATION = "org.apache.maven.global-settings";
040    String ALT_LOCAL_REPOSITORY_LOCATION = "maven.repo.local";
041
042    Settings buildSettings( MavenExecutionRequest request )
043        throws IOException, XmlPullParserException;
044
045    /**
046     * @return a <code>Settings</code> object from the user settings file.
047     * @throws IOException if any
048     * @throws XmlPullParserException if any
049     */
050    Settings buildSettings()
051        throws IOException, XmlPullParserException;
052
053    /**
054     * @param useCachedSettings if true, doesn't reload the user settings
055     * @return a <code>Settings</code> object from the user settings file.
056     * @throws IOException if any
057     * @throws XmlPullParserException if any
058     */
059    Settings buildSettings( boolean useCachedSettings )
060        throws IOException, XmlPullParserException;
061
062    /**
063     * @param userSettingsFile a given user settings file
064     * @return a <code>Settings</code> object from the user settings file.
065     * @throws IOException if any
066     * @throws XmlPullParserException if any
067     */
068    Settings buildSettings( File userSettingsFile )
069        throws IOException, XmlPullParserException;
070
071    /**
072     * @param userSettingsFile a given user settings file
073     * @param useCachedSettings if true, doesn't reload the user settings
074     * @return a <code>Settings</code> object from the user settings file.
075     * @throws IOException if any
076     * @throws XmlPullParserException if any
077     */
078    Settings buildSettings( File userSettingsFile, boolean useCachedSettings )
079        throws IOException, XmlPullParserException;
080
081}