1 /*
2 * Licensed to the Apache Software Foundation (ASF) under one
3 * or more contributor license agreements. See the NOTICE file
4 * distributed with this work for additional information
5 * regarding copyright ownership. The ASF licenses this file
6 * to you under the Apache License, Version 2.0 (the
7 * "License"); you may not use this file except in compliance
8 * with the License. You may obtain a copy of the License at
9 *
10 * http://www.apache.org/licenses/LICENSE-2.0
11 *
12 * Unless required by applicable law or agreed to in writing,
13 * software distributed under the License is distributed on an
14 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15 * KIND, either express or implied. See the License for the
16 * specific language governing permissions and limitations
17 * under the License.
18 */
19 package org.apache.maven.settings;
20
21 import java.io.File;
22 import java.io.IOException;
23
24 import org.apache.maven.execution.MavenExecutionRequest;
25 import org.codehaus.plexus.util.xml.pull.XmlPullParserException;
26
27 /**
28 * @author jdcasey
29 * @author Jason van Zyl
30 */
31 @Deprecated
32 public interface MavenSettingsBuilder {
33
34 String ROLE = MavenSettingsBuilder.class.getName();
35
36 String ALT_USER_SETTINGS_XML_LOCATION = "org.apache.maven.user-settings";
37 String ALT_GLOBAL_SETTINGS_XML_LOCATION = "org.apache.maven.global-settings";
38 String ALT_LOCAL_REPOSITORY_LOCATION = "maven.repo.local";
39
40 Settings buildSettings(MavenExecutionRequest request) throws IOException, XmlPullParserException;
41
42 /**
43 * @return a <code>Settings</code> object from the user settings file.
44 * @throws IOException if any
45 * @throws XmlPullParserException if any
46 */
47 Settings buildSettings() throws IOException, XmlPullParserException;
48
49 /**
50 * @param useCachedSettings if true, doesn't reload the user settings
51 * @return a <code>Settings</code> object from the user settings file.
52 * @throws IOException if any
53 * @throws XmlPullParserException if any
54 */
55 Settings buildSettings(boolean useCachedSettings) throws IOException, XmlPullParserException;
56
57 /**
58 * @param userSettingsFile a given user settings file
59 * @return a <code>Settings</code> object from the user settings file.
60 * @throws IOException if any
61 * @throws XmlPullParserException if any
62 */
63 Settings buildSettings(File userSettingsFile) throws IOException, XmlPullParserException;
64
65 /**
66 * @param userSettingsFile a given user settings file
67 * @param useCachedSettings if true, doesn't reload the user settings
68 * @return a <code>Settings</code> object from the user settings file.
69 * @throws IOException if any
70 * @throws XmlPullParserException if any
71 */
72 Settings buildSettings(File userSettingsFile, boolean useCachedSettings) throws IOException, XmlPullParserException;
73 }