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